springdoc-openapi用户界面实现将请求设置为HTTPS

 更新时间:2026年01月01日 15:56:55   作者:咚咚阳丶  
文章介绍了在使用Swagger进行API测试时遇到HTTPS请求问题的解决方案,包括将服务地址添加到配置文件和在SpringDoc配置类中设置服务列表,从而使得Swagger页面能够正确发起HTTPS请求

一、问题描述

当我们的服务接口需要通过HTTPS访问时,通过swagger可视化页面请求接口的时候,发起的是HTTP请求,导致请求无法到达后端,影响测试。

二、解决方法

1、将服务的地址添加到配置文件中

swagger:
  server-list: 
    #本地环境
  - 127.0.0.1:8007
    #线上https环境
  - https://www.xxx.com 

2、在SpringDoc的配置类中注入配置信息,并设置服务列表

import java.util.ArrayList;
import java.util.List;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import io.swagger.v3.oas.models.servers.Server;
import lombok.Data;

/**
 * spring doc配置
 * 
 * @author ldy
 */
@Data
@Configuration
@ConfigurationProperties(prefix = "swagger")
public class SpringDocConfig {

    /**
     * 服务地址列表
     */
    private List<String> serverList;

    @Bean
    public OpenAPI restfulOpenAPI() {
        OpenAPI openAPI = new OpenAPI()
                .info(new Info().title("你的项目名称").description("Spring Boot3 Restful API").version("V1.0.0")
                        .license(new License().name("访问SpringDoc官方网站").url("http://springdoc.org")))
                .externalDocs(
                        new ExternalDocumentation().description("欢迎访问LDY的技术博客").url("https://blog.csdn.net/ldy1016"));
         
        // 手动配置服务地址列表
        if (serverList != null && serverList.size() > 0) {
            List<Server> servers = new ArrayList<>();
            for (String server : serverList) {
                servers.add(new Server().url(server));
            }
            openAPI.servers(servers);
        }

        return openAPI;
    }

}

三、运行效果

如图所示,在swagger页面的 Servers 列表中选择指定的接口根路径即可,接口根路径会根据你的选择自动变更。

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Java动态数组添加数据的方法与应用示例

    Java动态数组添加数据的方法与应用示例

    这篇文章主要介绍了Java动态数组添加数据的方法,结合实例形式详细分析了Java动态数组的创建、添加、查找、打印等相关操作技巧,需要的朋友可以参考下
    2019-11-11
  • Java预览PDF时的文件名称问题及解决

    Java预览PDF时的文件名称问题及解决

    这篇文章主要介绍了Java预览PDF时的文件名称问题及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-01-01
  • Java利用AlphaComposite类合并图像

    Java利用AlphaComposite类合并图像

    这篇文章主要介绍了Java利用AlphaComposite类合并图像,帮助大家更好的利用Java处理图像,感兴趣的朋友可以了解下
    2020-10-10
  • java的jdbc简单封装方法

    java的jdbc简单封装方法

    本篇文章是对java的jdbc简单封装方法进行了详细的分析介绍,需要的朋友参考下
    2015-07-07
  • Java实现大文件的切割与合并操作示例

    Java实现大文件的切割与合并操作示例

    这篇文章主要介绍了Java实现大文件的切割与合并操作,结合实例形式分析了java基于io及util操作大文件按指定个数分割与合并相关操作技巧,需要的朋友可以参考下
    2018-07-07
  • java中pdf模版填充表单踩坑实战记录(itextPdf、openPdf、pdfbox)

    java中pdf模版填充表单踩坑实战记录(itextPdf、openPdf、pdfbox)

    这篇文章主要介绍了java中pdf模版填充表单踩坑的相关资料,OpenPDF、iText、PDFBox是三种常用的 PDF 处理库,它们各自具有独特的优势和特点,同时也存在一些局限性和差异,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2025-07-07
  • 解决RestTemplate 请求url中包含百分号 会被转义成25的问题

    解决RestTemplate 请求url中包含百分号 会被转义成25的问题

    这篇文章主要介绍了解决RestTemplate 请求url中包含百分号 会被转义成25的问题,具有很好的参考价值,希望对大家有所帮助。
    2021-10-10
  • Maven依赖中scope的含义

    Maven依赖中scope的含义

    本文主要介绍了Maven依赖中scope的含义,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-01-01
  • Java对象方法的调用执行过程详解

    Java对象方法的调用执行过程详解

    这篇文章主要介绍了Java对象方法的调用执行过程,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-02-02
  • Springmvc异常映射2种实现方法

    Springmvc异常映射2种实现方法

    这篇文章主要介绍了Springmvc异常映射2种实现方法以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。,需要的朋友可以参考下
    2020-05-05

最新评论