快捷導(dǎo)航

Spring boot配置 swagger的示例代碼

更新時(shí)間：2021年09月18日 17:14:25 作者：XiaoRunStar

Swagger是一組開源項(xiàng)目，Spring 基于swagger規(guī)范，可以將基于SpringMVC和Spring Boot項(xiàng)目的項(xiàng)目代碼，自動(dòng)生成JSON格式的描述文件，接下來通過本文給大家介紹Spring boot配置 swagger的示例代碼，一起看看吧

為什么使用Swagger

在實(shí)際開發(fā)中我們作為后端總是給前端或者其他系統(tǒng)提供接口，每次寫完代碼之后不可避免的都需要去寫接口文檔，首先寫接口文檔是一件繁瑣的事，其次由接口到接口文檔需要對(duì)字段、甚至是排版等。再加上如果我們是為多個(gè)系統(tǒng)提供接口時(shí)可能還需要按照不同系統(tǒng)的要求去書寫文檔，那么有沒有一種方式讓我們?cè)陂_發(fā)階段就給前端提供好接口文檔，甚至我們可以把生成好的接口文檔暴露出去供其他系統(tǒng)調(diào)用，那么這樣我只需要一份代碼即可。

Spring boot配置 swagger

1.導(dǎo)入maven依賴

<!--配置swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>

        <!--swagger第三方ui-->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

2.swagger配置類

@EnableSwagger2                // Swagger的開關(guān)，表示已經(jīng)啟用Swagger
@Configuration                 // 聲明當(dāng)前配置類
public class SwaggerConfiguration  {

    @Value("${swagger.basePackage}")
    private String basePackage;       // controller接口所在的包

    @Value("${swagger.title}")
    private String title;           // 當(dāng)前文檔的標(biāo)題

    @Value("${swagger.description}")
    private String description;         // 當(dāng)前文檔的詳細(xì)描述

    @Value("${swagger.version}")
    private String version;         // 當(dāng)前文檔的版本



    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage(basePackage))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title(title)
                .description(description)
                .version(version)
                .build();
    }

}

3.application.yml

# 配置swagger
swagger:
  basePackage: com.xx.demo.controller #包名
  title: 標(biāo)題  #標(biāo)題
  description: 項(xiàng)目文檔 #描述
  version: V1.0  #版本號(hào)

4.在controller里使用

@Api(tags = {"測(cè)試類"})
@RestController
@RequestMapping("/test")
public class TestController {
    @ApiOperation(value = "測(cè)試方法")
    @GetMapping("/xrx")
    public String xrx() {
        return "hello";
    }
}

5.訪問swagger

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

在這里插入圖片描述