springboot集成Swagger2接口文档
生活随笔
收集整理的這篇文章主要介紹了
springboot集成Swagger2接口文档
小編覺得挺不錯的,現在分享給大家,幫大家做個參考.
<!-- Swagger 接口文檔 --><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version></dependency><dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version></dependency>
新建配置類:
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.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2;@EnableSwagger2 @Configuration public class SwaggerConfig {public Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.any()).paths(PathSelectors.any()).build();}private ApiInfo apiInfo() {return new ApiInfoBuilder().build();} }http://localhost:8080/swagger-ui.html進行訪問
注解?? ?描述
@Api?? ?修飾整個類,描述Controller的作用
@ApiOperation?? ?描述一個類的一個方法,或者說一個接口
@ApiParam?? ?單個參數描述
@ApiModel?? ?用對象來接收參數
@ApiProperty?? ?用對象接收參數時,描述對象的一個字段
@ApiResponse?? ?HTTP響應其中1個描述
@ApiResponses?? ?HTTP響應整體描述
@ApiIgnore?? ?使用該注解忽略這個API
@ApiError?? ?發生錯誤返回的信息
@ApiImplicitParam?? ?一個請求參數
@ApiImplicitParams?? ?多個請求參數
?
總結
以上是生活随笔為你收集整理的springboot集成Swagger2接口文档的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 我的世界基岩怎么破坏
- 下一篇: Kafka入门之分组的理解