swagger学习

swagger是一个接口文档自动生成工具,兼接口测试,也是让人激动的一个工具,大爱推荐。

1 添加依赖配置

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.9.2</version>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>

2 四大注解说明:

1)   @Api注解于接口类上,描述类的作用

2)@ApiOperation注解用于方法上,描述方法的作用

3)@ApiModel注解于返回对象类上,描述接口出参入参对象类

4)  @ApiModelProperty注解用于对象属性定义上

3 访问地址:http://ip:port/swagger-ui.html

swagger学习