springBoot整合swagger2

最新推荐文章于 2024-12-14 23:52:27 发布

原创最新推荐文章于 2024-12-14 23:52:27 发布 · 947 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#java

java 专栏收录该内容

25 篇文章

订阅专栏

本文档介绍了如何在Spring Boot应用中集成Swagger2进行API文档的生成与管理，并提供了详细的配置步骤。同时，文章还涵盖了如何通过Nginx配置将Swagger UI的访问路径代理到应用服务器，确保在开发和测试环境中能够正常访问API文档。

1、导入jar

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
     <groupId>io.springfox</groupId>
     <artifactId>springfox-swagger2</artifactId>
     <version>2.9.2</version>
 </dependency>

2、代码配置类

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 1. swagger配置类
 */
@Configuration
@EnableSwagger2
//只在开发测试环境开放
@Profile({"dev","test"})
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //是否开启 (true 开启  false隐藏。生产环境建议隐藏)
                .enable(true)
                .select()
                //扫描的路径包,设置basePackage会将包下的所有被@Api标记类的所有方法作为api
     //.apis(RequestHandlerSelectors.basePackage("com.mcy.springbootswagger.controller"))
                .apis(RequestHandlerSelectors.any())
                //指定路径处理PathSelectors.any()代表所有的路径
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //设置文档标题(API名称)
                .title("基础数据平台接口规范说明")
                //文档描述
                .description("接口说明")
                //服务条款URL
                .termsOfServiceUrl("https://www.apache.org/licenses/LICENSE-2.0")
                //版本号
                .version("1.0.0")
                .build();
    }
}

3、nginx配置：其他配置不动，加下面配置

location ~* ^(/v2|/webjars|/swagger-resources|/swagger-ui.html){
       proxy_set_header Host $host;
       proxy_set_header  X-Real-IP  $remote_addr;
       proxy_set_header X-Forwarded-For $remote_addr;
       #proxy_set_header Host $host:$server_port;
       proxy_set_header X-Forwarded-Proto $scheme;
       proxy_set_header X-Forwarded-Port $server_port;
       proxy_pass http://ip:9090; 
}