swagger2 注解整体说明
@Api:用在请求的类上,表示对类的说明 tags="说明该类的作用,可以在UI界面上看到的注解" value="该参数没什么意义,在UI界面上也看到,所以不需要配置" @ApiOperation:用在请求的方法上,说明方法的用途、作用 value="说明方法的用途、作用" notes="方法的备注说明" @ApiImplicitParams:用在请求的方法上,表示一组参数说明 @ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面 name:参数名 value:参数的汉字说明、解释 required:参数是否必须传 paramType:参数放在哪个地方 · header --> 请求参数的获取:@RequestHeader · query --> 请求参数的获取:@RequestParam · path(用于restful接口)--> 请求参数的获取:@PathVariable · body(不常用) · form(不常用) dataType:参数类型,默认String,其它值dataType="Integer" defaultValue:参数的默认值 @ApiResponses:用在请求的方法上,表示一组响应 @ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息 code:数字,例如400 message:信息,例如"请求参数没填好" response:抛出异常的类 @ApiModel:用于响应类上,表示一个返回响应数据的信息 (这种一般用在post创建的时候,使用@RequestBody这样的场景, 请求参数无法使用@ApiImplicitParam注解进行描述的时候) @ApiModelProperty:用在属性上,描述响应类的属性
1、@Api:用在请求的类上,说明该类的作用
@Api:用在请求的类上,说明该类的作用 tags="说明该类的作用" value="该参数没什么意义,所以不需要配置"
示例:
@Api(tags="APP用户注册Controller")
2、@ApiOperation:用在请求的方法上,说明方法的作用
@ApiOperation:"用在请求的方法上,说明方法的作用" value="说明方法的作用" notes="方法的备注说明"
示例:
@ApiOperation(value="用户注册",notes="手机号、密码都是必输项,年龄随边填,但必须是数字")
3、@ApiImplicitParams:用在请求的方法上,包含一组参数说明
@ApiImplicitParams:用在请求的方法上,包含一组参数说明 @ApiImplicitParam:用在 @ApiImplicitParams 注解中,指定一个请求参数的配置信息 name:参数名 value:参数的汉字说明、解释 required:参数是否必须传 paramType:参数放在哪个地方 · header --> 请求参数的获取:@RequestHeader · query --> 请求参数的获取:@RequestParam · path(用于restful接口)--> 请求参数的获取:@PathVariable · body(不常用) · form(不常用) dataType:参数类型,默认String,其它值dataType="Integer" defaultValue:参数的默认值
示列:
@ApiImplicitParams({ @ApiImplicitParam(name="mobile",value="手机号",required=true,paramType="form"), @ApiImplicitParam(name="password",value="密码",required=true,paramType="form"), @ApiImplicitParam(name="age",value="年龄",required=true,paramType="form",dataType="Integer") })
4、@ApiResponses:用于请求的方法上,表示一组响应
@ApiResponses:用于请求的方法上,表示一组响应 @ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息 code:数字,例如400 message:信息,例如"请求参数没填好" response:抛出异常的类
示例:
@ApiOperation(value = "select1请求",notes = "多个参数,多种的查询参数类型") @ApiResponses({ @ApiResponse(code=400,message="请求参数没填好"), @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对") })
5、@ApiModel:用于响应类上,表示一个返回响应数据的信息
@ApiModel:用于响应类上,表示一个返回响应数据的信息 (这种一般用在post创建的时候,使用@RequestBody这样的场景, 请求参数无法使用@ApiImplicitParam注解进行描述的时候) @ApiModelProperty:用在属性上,描述响应类的属性
示例:
import io.swagger.annotations.ApiModel; import io.swagger.annotations.ApiModelProperty; import java.io.Serializable; @ApiModel(description= "返回响应数据") public class RestMessage implements Serializable{ @ApiModelProperty(value = "是否成功") private boolean success=true; @ApiModelProperty(value = "返回对象") private Object data; @ApiModelProperty(value = "错误编号") private Integer errCode; @ApiModelProperty(value = "错误信息") private String message; /* getter/setter */ }
相关推荐
swagger 用户已api文档自动生成,可以大幅提高客户端和服务端的开发人员的协作效率。本资源主要描述了swagger 注解的使用方法。
微服务分布式架构实践,swagger 接口文档注释,下载即运行【代码完整】
idea配置数据库,反向生成实体类demo,支持lombok,swagger2注解
根据字段上的doc注释生成swagger注解 @ApiModelProperty(value = "当前登录人名称") 快捷键 ctrl+n \command+n \右键Generate 打开generate页面,选择swagger
swagger 常用注解学习总结
springBoog和Swagger2使用的接口注解,自己整理的注解使用说明
赠送jar包:springfox-swagger2-2.2.2.jar; 赠送原API文档:springfox-swagger2-2.2.2-javadoc.jar; 赠送源代码:springfox-swagger2-...人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。
-- swagger2 依赖开始--> <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <groupId>io.springfox <artifactId>springfox-swagger2 <version>2.9.2 <groupId>io.swagger ...
赠送jar包:springfox-swagger2-2.9.2.jar; 赠送原API文档:springfox-swagger2-2.9.2-javadoc.jar; 赠送源代码:springfox-swagger2-...人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。
赠送jar包:springfox-swagger2-2.7.0.jar; 赠送原API文档:springfox-swagger2-2.7.0-javadoc.jar; 赠送源代码:springfox-swagger2-...人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。
md文件,swagger2中相当于api了吧写了我tm12个小时,翻着源码写的
swagger @ApiModel 返回内容注释不显示问题 展开无类信息
赠送jar包:springfox-swagger2-3.0.0.jar; 赠送原API文档:springfox-swagger2-3.0.0-javadoc.jar; 赠送源代码:springfox-swagger2-...人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。
SpringMVC 集成Swagger2,相关说明可以打开 https://blog.csdn.net/everyday_hzg/article/details/80537902
用swagger2markup导出swagger2项目的html,pdf的离线文档。解决生成pdf中文乱码以及缺失的问题,支持自定义字体。 修改pom.xml中的 swagger.input属性值中的ip和port 执行mvn clean test完成之后,会在/target/...
赠送jar包:springfox-swagger2-2.9.2.jar; 赠送原API文档:springfox-swagger2-2.9.2-javadoc.jar;...人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。 双语对照,边学技术、边学英语。
赠送jar包:springfox-swagger2-2.4.0.jar 赠送原API文档:springfox-swagger2-2.4.0-javadoc.jar ...人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。 双语对照,边学技术、边学英语。
swagger2Demo,swagger,这个是写的一个demo,用于调试接口swagger确实好用,jdk1.8的,欢迎下载,
赠送jar包:springfox-swagger2-3.0.0.jar; 赠送原API文档:springfox-swagger2-3.0.0-javadoc.jar;...人性化翻译,文档中的代码和结构保持不变,注释和说明精准翻译,请放心使用。 双语对照,边学技术、边学英语。
springboot 整合swagger2.0支持API注释显示 springboot 整合swagger2.0支持API注释显示 springboot 整合swagger2.0支持API注释显示