Spring boot集成Swagger2实现自动生成API文档

spring boot集成swagger2实现自动生成API文档，集成配置步骤（gradle管理jar包方式）如下：

添加swagger2的jar包
compile group: ‘io.springfox’, name: ‘springfox-swagger2’, version: ‘2.8.0’
compile group: ‘io.springfox’, name: ‘springfox-swagger-ui’, version: ‘2.8.0’
添加swagger2配置类

package com.easydatalink.token.config;

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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**

Swagger Api配置
@author wangXX
@version Created：2019年3月25日

*/
@Configuration
#@EnableSwagger2
public class Swagger2Config{
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2).forCodeGeneration(true)
.select()
.apis(RequestHandlerSelectors.any())
//过滤生成链接
.paths(PathSelectors.any())
.build()
.apiInfo(apiInfo());
}

//api接口作者相关信息
private ApiInfo apiInfo() {
    Contact contact = new Contact("wang", "", "pingfan_wz[email protected]");
    ApiInfo apiInfo = new ApiInfoBuilder()
            .license("Token管理API")
            .title("Token管理API")
            .description("接口文档")
            .contact(contact)
            .version("1.0")
            .build();
    return apiInfo;
}

}

controller层添加swagger注解
spring boot启动类中添加@EnableSwagger2注解开启swagger，并配置api扫描路径要在扫描目录下，否则不能生成api
访问地址：http://172.18.9.112:8885/swagger-ui.html#/

Spring boot集成Swagger2实现自动生成API文档

相关推荐