SpringBoot&swagger
2019-07-10 14:15
18 查看
版权声明:本文为博主原创文章,遵循 CC 4.0 by-sa 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/lx529068450/article/details/95315439
@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:用在属性上,描述响应类的属性 --------------------- 作者:xiaojin21cen 来源:CSDN 原文:https://blog.csdn.net/xiaojin21cen/article/details/78654652?utm_source=copy 版权声明:本文为博主原创文章,转载请附上博文链接!
@Autowired //可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。通过Autowired的使用来消除 set,get方法 @ResponseBody //这个注解通常使用在控制层(controller)的方法上,其作用是将方法的返回值以特定的格式写入到response的body区域,进而将数据返回给客户端。当方法上面没有写ResponseBody,底层会将方法的返回值封装为ModelAndView对象。 @ApiModelProperty() 用于方法,字段; 表示对model属性的说明或者数据操作更改 value–字段说明 name–重写属性名字 dataType–重写属性类型 required–是否必填 example–举例说明 hidden–隐藏 @JsonProperty 此注解用于属性上,作用是把该属性的名称序列化为另外一个名称,如把trueName属性序列化为name,@JsonProperty("name")。 对属性名称重命名,比如在很多场景下Java对象的属性是按照规范的驼峰书写,但在数据库设计时使用的是下划线连接方式,此处在进行映射的时候 就可以使用该注解。
红色字\color{red}{红色字}红色字
加粗
相关文章推荐
- swagger+springboot实现前(vue)后端分离
- spring-boot-starter-swagger 1.2.0.RELEASE:新增分组配置功能
- 引入swagger(2)——与spring-boot整合
- 采用shardbatis在springBoot中实现表的水平拆分,整合swagger,mybatis,shardbatis,pagehelper
- Spring 初探(1) boot,swagger,eureka,hystrix
- springboot整合swagger2
- spring boot 集成 swagger
- 采用shardbatis在springBoot中实现表的水平拆分,整合swagger,mybatis,shardbatis,pagehelper
- [置顶] spring boot项目实战:swagger2在线文档
- SpringBoot和Swagger结合提高API开发效率
- Spring Boot 集成Swagger
- 5分钟构建springboot、maven、swagger项目
- Spring boot整合Swagger
- Spring boot 中使用swagger-ui实现 restful-api
- springboot+jpa+vue+swagger测试小demo
- springboot + swagger
- Spring Boot 集成Swagger
- springboot整合swagger
- springboot + swagger
- 使用 SpringBoot + Swagger 生成接口 API 文档