使用Swagger 管理项目API

背景简介

当前的业务以前后端分离为主，在接口联调时，手动更新接口信息繁琐切容易出错，使用swagger 可简化api文档生成，接下来基于springboot项目，以一个示例简介如何使用以及遇到的一些问题

使用

1、pom依赖

        
            io.springfox
            springfox-swagger-ui
            2.9.2

2、工程配置

在程序入口使用配置

@EnableSwagger2
@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication .class, args);
    }

}

编写配置类

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;

@Configuration
public class Swagger2 {


    //swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
    @Bean
    public Docket createRestApi() {
        return new Docket(documentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.test"))
                .paths(PathSelectors.any())
                .build();
    }
    //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title(" API document.")
                //版本号
                .version("1.0")
                //描述
                .description("API 描述")
                .build();
    }
}

完成以上步骤即配置完成

3、使用方法

启动项目，访问 http://127.0.0.1:8080/swagger-ui.html 既可

拓展内容

以上内容即完成了swagger的配置，但以上内容在生产环境中暴露了就存在一定的风险，所以需要在生产环境中关系swagger配置。查阅资料后在application.yml中增加配置

swagger:
  enable: false

但是却没有生效

查阅资料后使用@ConditionalOnProperty 可使配置不生效，该注解主要通过name， havingValue两个值来判断该配置是否生效，其中name从配置文件中读取值，该值再与havingValue进行比较

1. 若结果相同，则返回true，该配置生效

2. 若结果不同，则返回false，该配置不生效

基于这个注解，修改配置文件为


import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;

@Configuration
@ConditionalOnProperty(name = "swagger.enable", havingValue = "true")
public class Swagger2 {

    @Value("${swagger.enable}")
    private Boolean enable;
    //swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
    @Bean
    public Docket createRestApi() {
        return new Docket(documentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.test"))
                .paths(PathSelectors.any())
                .build();
    }
    //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("API document.")
                //版本号
                .version("1.0")
                //描述
                .description("API 描述")
                .build();
    }
}

但重启后仍能访问swagger页面，配置仍然没有生效，检查后，推测是@EnableSwagger2 写在程序入口导致失效，修改至配置页面成功生效，最终代码如下

import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;

@Configuration
@EnableSwagger2
@ConditionalOnProperty(name = "swagger.enable", havingValue = "true")
public class Swagger2 {

    @Value("${swagger.enable}")
    private Boolean enable;
    //swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
    @Bean
    public Docket createRestApi() {
        return new Docket(documentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.test"))
                .paths(PathSelectors.any())
                .build();
    }
    //构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title(" API document.")
                //版本号
                .version("1.0")
                //描述
                .description("API 描述")
                .build();
    }
}

至此，配置生效，此处遗留两个待补充项，一位@ConditionalOnProperty 详解，一为spring启动机制，日后填坑~

使用Swagger 管理项目API

Java相关栏目本月热门文章