Swagger的接收参数的注解问题

Question

Swagger 的请求参数如果是属性用@ApiParam注解，那如果是实体类用什么注解  

比如： 

public String addUser(@ApiParam(required = true, name = "postData", value 
= "用户信息json数据") @RequestParam( value = "postData") String postData, HttpServletRequest request)throws JSONException     {  
  
        JSONObject json = new JSONObject();        

        json.put("postData", postData);         

        return json.toString();     

}  

那如果我用来接收参数的是一个实体类（User）的话，该用什么注解 

public String addUser(User user, HttpServletRequest request)throws JSONException     {  
  
        JSONObject json = new JSONObject();        

        json.put("postData", user.getPostData);         

        return json.toString();     

} 

Answer 1

我也碰到这个问题，找到解决办法了吗

Answer 2

同求，现在也在找解决方案，有对应解决方案吗

Answer 3

是的,有解决方案吗

Answer 4

回复
请问找到解决办法了吗？如果属性都是平级的还好解决，但是我们好多请求是需要嵌套属性的，一个对象包含一个对象，这样该怎样忽略不需要的属性呢

Answer 5

封装参数的对象的某些属性是必填的，如何使用swagger注解注释类里面的属性，而且该类可被多个方法使用，不同方法使用的必填的属性是不同的

Answer 6

看看这篇文章 http://blog.csdn.net/zjx2016/article/details/73923995

Answer 7

 .ignoredParameterTypes(ApiIgnore.class);

@ApiIgnore Employee employee

最主要是这句，我的可以运行，没问题。

 

new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo)
        .select()
        .apis(RequestHandlerSelectors.basePackage("com"))
        .paths(PathSelectors.any())
        .build()
        .ignoredParameterTypes(ApiIgnore.class);

 

@ApiOperation(value = "更新员工信息", notes = "更新员工信息", response = SwaggerSimpleResultConstant.class)
@ApiImplicitParams({
    @ApiImplicitParam(name = "id", value = "主键ID", required = true, paramType = "path"),
    @ApiImplicitParam(name = "name", value = "姓名", required = true, paramType = "query")})
@RequestMapping(value = "/{id}", method = { RequestMethod.PUT })
public Map<ControllerResultConstant, Object> edit(@ApiIgnore Employee employee) {

 

 

 

Answer 8

接收参数和swagger貌似没什么关系吧，在没集成swagger之前不也可以接收吗？我现在想修改swagger生成参数的默认值，知道怎么做吗？

Answer 9

在类里面 属性加上：

    @ApiModelProperty(value = "数据模型ID", required = false)
    private String modelId;

 

Answer 10

你好，这个问题你是怎么解决的？

Answer 11

非常好，后台用自定义Bean+@RequestBody去接受json，如果不加.ignoredParameterTypes(自定义Bean.class)；在swagger页面会有两个参数输入框

Answer 12

引用来自“F_GSong”的评论

如果是GET方法中用User对象来接收多个请求参数的话，在Swagger的配置类中加上

.ignoredParameterTypes(User.class)

然后在controller的方法上用

@ApiImplicitParams和@ApiImplicitParam

Answer 13

你好，知道如何修改swagger生成的参数的默认值吗？

Answer 14

没有看明白你的问题，但是你标记的最佳答案也不太理解

Answer 15

问一下 假设我的接口返回很多参数需要加上注释用什么注解呢？比如有 name,age,sex,然后这些参数需要给前端展示具体的含义怎么搞？

Answer 16

哈哈，非常感謝，看到你的评论，我得问题得到的解决。

Answer 17

感谢，虽然和问题不太相干，却正好解决了我的问题

Answer 18

如果是GET方法中用User对象来接收多个请求参数的话，在Swagger的配置类中加上

.ignoredParameterTypes(User.class)

然后在controller的方法上用

@ApiImplicitParams和@ApiImplicitParam

Answer 19

加入@RequestBody注解

public String addUser(@ApiParam @RequestBody User user, HttpServletRequest request)