1.添加相关的依赖
<dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.6.1</version> <scope>compile</scope> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.6.1</version> </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:用对象来接收参数时,描述对象的一个字段