Swagger和SpringMvc集成步骤

1.添加相关的依赖

<dependency>

<groupId>io.springfoxgroupId>

<artifactId>springfox-swagger2artifactId>

<version>2.6.1version>

<scope>compilescope>

dependency>

<dependency>

<groupId>io.springfoxgroupId>

<artifactId>springfox-swagger-uiartifactId>

<version>2.6.1version>

dependency>

 

2.在Controller层中的方法使用注解@ApiOperation(value="接口说明")

 

3.启动类使用@EnableSwagger2注解

 

4.启动,然后访问:http://localhost:8080/swagger-ui.html

 

出现这个页面表示成功

 

 

swagger常用的注解:

1⃣️Api:修饰整个类,描述Controller的作用

2⃣️ApiOperation:描述一个类的一个方法,或者是一个接口

3⃣️ApiParam:单个参数描述

4⃣️ApiModel:用对象来接收参数

5⃣️ApiProperty:用对象来接收参数时,描述对象的一个字段

你可能感兴趣的:(框架)