Swagger2 介绍

swagger2

编写和维护接口文档是每个程序员的职责，根据swagger2可以快速帮助我们编写最新的API接口文档，再也不用担心开会前扔忙于整理各种资料了，简介提高了团队开发的沟通效率

常用注解

@Api: 修饰整个类，描述controller的作用

@ApiOperation: 描述一个类的一个方法，或者说一个接口

@ApiParam: 单个参数描述

@ApiModel: 用对象来接受参数

@ApiProperty:用对象来接受参数时，描述对象的一个字段

@ApiResponse: HTTP响应其中一个描述

@ApiResponses: HTTP响应整个描述

@ApiIgnore: 使用注解忽略这个API

@ApiError: 发生错误返回的信息

@ApiImplicitParam: 一个请求参数

@ApiImpliocitParams: 多个请求参数