Spring Boot中使用Swagger2的用法

        Spring MVC程序配合组织出强大RESTful API文档。它既可以减少我们创建文档的工作量,同时说明内容又整合入实现代码中,让维护文档和修改代码整合为一体,可以让我们在修改代码逻辑的同时方便的修改文档说明。另外Swagger2也提供了强大的页面测试功能来调试每个RESTful API。

1.Swagger2注解的用法:

@Api()用于类; 

表示标识这个类是swagger的资源 

@ApiOperation()用于方法; 
表示一个http请求的操作 


@ApiParam()用于方法,参数,字段说明; 
表示对参数的添加元数据(说明或是否必填等) 


@ApiModel()用于类 
表示对类进行说明,用于参数用实体类接收 


@ApiModelProperty()用于方法,字段 
表示对model属性的说明或者数据操作更改 


@ApiIgnore()用于类,方法,方法参数 
表示这个方法或者类被忽略 


@ApiImplicitParam() 
用于方法 表示单独的请求参数 


@ApiImplicitParams() 

用于方法,包含多个 @ApiImplicitParam

猜你喜欢

转载自blog.csdn.net/ty0903csdn/article/details/81016557