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

最新推荐文章于 2025-11-19 16:17:16 发布

原创最新推荐文章于 2025-11-19 16:17:16 发布 · 539 阅读

1 ·

本内容遵循CC 4.0 BY-SA版权协议

收录于

spring boot

API

swagger

本文介绍了如何在Spring Boot项目中集成Swagger2，通过添加必要的jar包，配置Swagger2配置类以及在Controller层添加注解，实现自动生成API文档。详细步骤包括添加依赖、创建配置类和启用Swagger2。完成配置后，可以通过指定URL访问生成的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_wzc@163.com");
    ApiInfo apiInfo = new ApiInfoBuilder()
            .license("Token管理API")
            .title("Token管理API")
            .description("接口文档")
            .contact(contact)
            .version("1.0")
            .build();
    return apiInfo;
}

}