Springboot 配置Swagger

一、導入pom依賴

<!--swagger 文檔註釋-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>
<!--swagger-->

二、編寫swagger配置

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.bind.annotation.RestController;
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;
 

@Configuration
@EnableSwagger2
public class Swagger2Config {
 
    // swagger2的配置文件，這裏可以配置swagger2的一些基本的內容，比如掃描的包等等
    @Bean
    public Docket createRestApi() {
                // 文檔類型
        return new Docket(DocumentationType.SWAGGER_2)
                // 創建api的基本信息
                .apiInfo(apiInfo())
                // 選擇哪些接口去暴露
                .select()
                // 掃描的包                                     
                .apis(RequestHandlerSelectors.withClassAnnotation(com.demo.controller))
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(pars)
                .apiInfo(apiInfo());
    }
 
    // 構建 api文檔的詳細信息函數,注意這裏的註解引用的是哪個
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Swagger RESTful API")
                .description("Swagger文檔 API 描述")
                .termsOfServiceUrl("www.xxxx.com")
                .version("1.0")
                .build();
    }
 
}

• 可以訪問localhost:port/swagger-ui.html看到生成的swagger文檔。
• 可以訪問http://localhost:8080/v2/api-docs可以獲取到json格式的數據，訪問http://editor.swagger.io/可以將json數據轉換成yaml文件並下載到本地

swagger常用註解：

1. @Api：修飾整個類，描述Controller的作用
2. @ApiOperation：描述一個類的一個方法，或者說一個接口
3. @ApiParam：單個參數描述
4. @ApiModel：用對象來接收參數
5. @ApiProperty：用對象接收參數時，描述對象的一個字段
6. @ApiResponse：HTTP響應其中1個描述
7. @ApiResponses：HTTP響應整體描述
8. @ApiIgnore：使用該註解忽略這個API
9. @ApiError ：發生錯誤返回的信息
10. @ApiParamImplicitL：一個請求參數
11. @ApiParamsImplicit ：多個請求參數

三、修改添加application.properties文件

#是否激活 swagger true or false
swagger.enable=true

附：Google瀏覽器手動設置cookie

在console窗口中輸入如下代碼刷新頁面即可

document.cookie="keyName=cookeiValue"