Swagger注解

swagger2注解中的全参数

@Api 

Api 标记可以标记一个Controller类做为swagger 文档资源,使用方式

@ApiOperation每一个url资源的定义,使用方式

@ApiParam标记参数

@ApiImplicitParams:用在请求的方法上,包含一组参数说明

@ApiImplicitParam对容器的描述

@ApiResponse用于请求的方法上,表示一组响应

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

                      value–表示对象名

                      description–描述

                       都可省略

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

                      value–字段说明

                      name–重写属性名字

                      dataType–重写属性类型

                      required–是否必填

                      example–举例说明

                      hidden–隐藏

                      都可省略

更详细请看链接:swagger注解

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

友情链接更多精彩内容