swagger参数注解,后台使用@RequestBody注解的实体类,但只需要传实体类中的一个属性

简介: 这样写的结果会是下面这个样子,导致出现两个参数,一个实体类传参类型是json格式,一个是注解中写的属性。

一开始是这个样子的


@ApiOperation(value = "删除用户", notes = "根据用户名删除指定用户", httpMethod = "POST")
  @ApiImplicitParam(
  name = "username", value = "用户的用户名", required = true, dataType="String"
  )
  @ApiResponses({
     //code重复的情况下,第一个声明的生效。
     @ApiResponse(code = 200,message = "删除成功" ),
     @ApiResponse(code = 202,message = "删除失败,用户不存在")
  })
  @ApiVersion(group = ApiVersionConstant.FAP_APP100)
  @RequestMapping(value = "delete", method = RequestMethod.POST)
  public Boolean deleteUser(@RequestBody UserDemo user,HttpServletResponse response) {

这样写的结果会是下面这个样子,导致出现两个参数,一个实体类传参类型是json格式,一个是注解中写的属性。


而且只能在实体类的json字符串中填写要传的值,在下面的属性输入框输入值,传到后台是null。因为后台使用的是@RequestBody注解,只接收json字符串



而且页面上面还会报一个错,其实就是你的参数是一个实体类,而你的dateType写的是String。



在@RequestBody前面添加一个注解,@APIIgnore


public Boolean deleteUser(@ApiIgnore @RequestBody UserDemo user,HttpServletResponse response)

页面变成了这个亚子,只剩下这个属性参数,但是……这样你输入一个值,点击发送请求是发不过去的,因为后台是@RequestBody注解的实体类,只接收json类型的字符串,这样发出去的一个键值对或者只是一个你输入的字符串,而不是json类型,



继续改,在参数属性注解里添加一个paramType属性,再把dateType属性删了(删了就不报错了)


@ApiImplicitParam(

 name = "username", value = "用户的用户名-String", required = true, paramType="body"

)

结果就是,可以输入json字符串,也不报错。但是就有一点问题,就是不知道参数的类型,我觉得可以在参数描述那里的value里面加上一个参数类型。就像这样。



如果本文帮助到了你,别忘了点赞加关注哦


你点的每个赞,我都认真当成了喜欢


相关文章
|
7月前
|
Java API
Swagger 常用注解使用详解
Swagger 常用注解使用详解
138 2
|
3月前
|
API
Swagger2 常用注解介绍
Swagger2 常用注解介绍
|
5月前
|
JSON 数据格式
MysbatisPlus-核心功能-IService开发基础业务接口,MysbatisPlus_Restful风格,新增@RequestBody指定是为了接收Json数据的,使用swagger必须注解
MysbatisPlus-核心功能-IService开发基础业务接口,MysbatisPlus_Restful风格,新增@RequestBody指定是为了接收Json数据的,使用swagger必须注解
|
7月前
|
Dubbo Java 测试技术
提升API文档品质:Swagger annotations (注解)使用教程
Swagger 提供的注解集是其框架中定义 API 规范和文档的重要工具。这些注解在代码里标注重要部分,为 Swagger 的解析工作铺路,进而生成详尽的 API 文档。开发者编写的注释能够被转换成直观的文档,并展现API端点、参数和响应等信息。这不仅提升了开发人员对 API 运作的理解与沟通,也使得测试和集成过程更加顺畅。
|
7月前
|
搜索推荐
Swagger中的一些常用注解(下)
Swagger中的一些常用注解(下)
74 0
|
7月前
|
API
Swagger中的一些常用注解(上)
Swagger中的一些常用注解(上)
55 0
|
7月前
|
JSON 前端开发 Java
历经14天自定义3个注解解决项目的3个Swagger难题
历经14天自定义3个注解解决项目的3个Swagger难题
179 0
swagger2 注解说明 @ApiImplicitParam和@ApiImplicitParams的用法
swagger2 注解说明 @ApiImplicitParam和@ApiImplicitParams的用法
103 0
|
API
Swagger核心注解总结(四)
Swagger核心注解总结(四)
231 2