1.使用swagger的原因

手寫Api文檔的幾個痛點：

文檔需要更新的時候，需要再次發(fā)送一份給前端，也就是文檔更新交流不及時。

接口返回結果不明確

不能直接在線測試接口，通常需要使用工具，比如postman

接口文檔太多，不好管理

2.依賴包配置

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

3.配置類

package com.oukingtim.config;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.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; 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 {@Beanpublic Docket createRestApi() {List<Parameter> pars = new ArrayList<>();return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))//.apis(RequestHandlerSelectors.basePackage("方法二：掃描包位置")).paths(PathSelectors.any()).build().globalOperationParameters(pars).apiInfo(apiInfo());}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("劉云生 RESTful API").description("郵箱：578888218@qq.com").description("博客地址：https://blog.csdn.net/liuyunshengsir/").termsOfServiceUrl("https://blog.csdn.net/liuyunshengsir/").version("1.0").build();} }

4.Swagger注解（）

swagger通過注解表明該接口會生成文檔，包括接口名、請求方法、參數、返回信息的等等。詳細請自行了解

• @Api：修飾整個類，描述Controller的作用
• @ApiOperation：描述一個類的一個方法，或者說一個接口
• @ApiParam：單個參數描述
• @ApiModel：用對象來接收參數
• @ApiProperty：用對象接收參數時，描述對象的一個字段
• @ApiResponse：HTTP響應其中1個描述
• @ApiResponses：HTTP響應整體描述
• @ApiIgnore：使用該注解忽略這個API
• @ApiError ：發(fā)生錯誤返回的信息
• @ApiImplicitParam：一個請求參數
• @ApiImplicitParams：多個請求參數

5.其他

務必將權限攔截排除

#訪問地址 http://localhost:8080/swagger-ui.html

6.統(tǒng)一加入Authorization

package com.lys.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.*; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spi.service.contexts.SecurityContext; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2;import java.util.ArrayList; import java.util.Collections; import java.util.List; /*** @Auther: liuysh* @Date: 2021/6/26 12:26* @Description:*/ @Configuration @EnableSwagger2 public class SwaggerConfig {@Beanpublic Docket api() {return new Docket(DocumentationType.SWAGGER_2).useDefaultResponseMessages(false).select().apis(RequestHandlerSelectors.basePackage("com.lys.controller")).paths(PathSelectors.regex("^(?!auth).*$")).build().securitySchemes(securitySchemes()).securityContexts(securityContexts()).apiInfo(apiInfo());}private List<ApiKey> securitySchemes() {List<ApiKey> list =new ArrayList<>();list.add(new ApiKey("Authorization", "Authorization", "header"));return list;}private List<SecurityContext> securityContexts() {return new ArrayList(Collections.singleton(SecurityContext.builder().securityReferences(defaultAuth()).forPaths(PathSelectors.regex("^(?!auth).*$")).build()));}List<SecurityReference> defaultAuth() {AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];authorizationScopes[0] = authorizationScope;return new ArrayList(Collections.singleton(new SecurityReference("Authorization", authorizationScopes)));}private ApiInfo apiInfo() {return new ApiInfoBuilder().title("微服務-XXX api文檔").description("restful 風格接口")// 服務條款網址.termsOfServiceUrl("https://blog.csdn.net/liuyunshengsir").version("1.0").contact(new Contact("帥呆了", "url", "email")).build();} }

總結

以上是生活随笔為你收集整理的springboot集成配置swaggerUI的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。