使用swagger2自动生成清晰明了的接口文档

自动生成的接口文档也可以清晰明了

web开发写一个接口就需要添加一个接口文档，又浪费时间，接口文档还不够详细，使用swagger2从此我再也不写接口文档了，自动生成文档，还让人一看就清晰明了。

swgger2生成接口文档步骤

1. 使用maven引入swagger2接口自动生成包

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

• 注解说明

  • @Api：用在类上，说明该类的作用。

  • @ApiOperation：注解来给API增加方法说明。

  • @ApiImplicitParams : 用在方法上包含一组参数说明。

  • @ApiImplicitParam：用来注解来给方法入参增加说明。

  • @ApiResponses：用于表示一组响应

  • @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息

• @ApiModel：描述一个Model的信息（一般用在请求参数无法使用* @ApiImplicitParam注解进行描述的时候）

  • @ApiModelProperty：描述一个model的属性

2. 新建config包，在包下新建swgger2配置类

3. 在参数实体类上添加注解

4. 在应用入口处扫描包

package com.supermanshirts;import org.mybatis.spring.annotation.MapperScan;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;//扫描包@SpringBootApplication(scanBasePackages = "com.supermanshirts")@MapperScan("com.supermanshirts.mapper")public class SupermanshirtsApplication { public static void main(String[] args) { SpringApplication.run(SupermanshirtsApplication.class, args); }}

5. 在controller控制器中添加Api注解和方法接口注解

我是爱分享的东东，求点赞求转发,你有什么好的推荐欢迎也分享给我吧，共分享共进步。