Spring Boot添加swagger

最新推荐文章于 2025-11-11 07:15:00 发布

原创最新推荐文章于 2025-11-11 07:15:00 发布 · 308 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#Spring Boot #swagger

Java 同时被 2 个专栏收录

21 篇文章

订阅专栏

后端框架

12 篇文章

订阅专栏

本文详细介绍如何在Spring项目中配置Swagger，实现API文档自动生成，并展示了如何在分布式系统中利用pom依赖进行Swagger配置的统一管理。同时，文章还介绍了Swagger与Spring Cloud Gateway的集成方法，以便将不同微服务的文档整合。

swagger配置

swagger配置信息可被通过pom依赖继承，在分布式系统中在一个公共项目中配置一次即可

package com.dirk.demo.config;

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.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

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

/**
 * @Author: Dirk
 * @Description: Swagger configure
 * @Date: Created at 18:08 2018/3/30
 */

@Configuration
@EnableSwagger2
@Profile({"dev"})
public class Swagger2 {

	@Bean
    public Docket api() {

        List<Parameter> pars = new ArrayList<>();

        ParameterBuilder tokenBuilder = new ParameterBuilder();
        ParameterBuilder token = tokenBuilder
                .name("Authorization")
                .description("用户token，非必传")
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                .required(false);
                
        pars.add(token.build());
       
       return new Docket(DocumentationType.SWAGGER_2)
                .globalOperationParameters(pars)
                .apiInfo(apiInfo())
                .select()
//                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API 文档")
                .description("Project Api document")
                .version("API V1.0")
                .build();
    } 
}

pom依赖

<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>

访问地址

http://localhost:8080/swagger-ui.html

补充

swagger在spring cloud项目中可以和spring cloud gateway集成使用，将不容微服务独立的swagger文档整合到同一域名下，需要重写SwaggerResourcesProvider接口以及@RequestMapping("/swagger-resources")重写数据来源
swagger