Swagger

在spring boot中集成Swagger

新建一個swagger項目

maven依賴

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version> </dependency><!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui --> <dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version> </dependency>

編寫配置類

@Configuration @EnableSwagger2 public class SwaggerConfig {@Beanpublic Docket docket(Environment environment){boolean flag = environment.acceptsProfiles(Profiles.of("dev","test"));return new Docket(DocumentationType.SWAGGER_2).apiInfo(new ApiInfo("Api Documentation","Api Documentation","1.0","",new Contact("yao","",""),"pandown 1.0","http://www.apache.org/licenses/LICENSE-2.0",new ArrayList())) //定義ApiInfo.enable(flag) //是否啟用sawwger.groupName("組名") //配置分組.select().apis(RequestHandlerSelectors.basePackage("com.wenyao.swagger.controller")) //包掃描.paths(PathSelectors.ant("/")) //路徑過濾.build();}}

@ApiModel和@ApiModelProperty

@ApiModel用于給一個類添加描述名

@ApiModelProperty給屬性添加描述

@ApiModel("用戶") public class User {@ApiModelProperty("編號")private int id;@ApiModelProperty("用戶名")private String username;@ApiModelProperty("密碼")private String password; }

@ApiOperation和@ApiParam

@RestController public class HelloController {@ApiOperation("接口注釋")@RequestMapping("/hello")public String hello(){return "hello";}public String hello2(@ApiParam("參數(shù)注釋") String var){return "hello";} }

總結(jié)

以上是生活随笔為你收集整理的在spring boot中集成Swagger的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。