在摇摆不定中使用@ApiParam还是@ApiModelProperty?

2022-09-03 06:32:09

以下两个注释都适用于将元数据添加到 swagger-ui 文档中。哪一个应该更受欢迎,为什么?

public class MyReq {

    @ApiModelProperty(required = true, value = "the persons name")
    @ApiParam(required = true, value = "the persons name")
    private String name;
}

@RestController
public class MyServlet {
   @RequestMapping("/") 
   public void test(MyReq req) {

   }
}

答案 1

两者之间有很大的区别。它们都用于向 swagger 添加元数据,但它们添加不同的元数据。

@ApiParam 用于参数。它通常在 API 资源请求类中定义。

@ApiParam示例:

/users?age=50

它可用于定义参数 age 和以下字段:

  • 参数类型:查询
  • 姓名:年龄
  • 描述:用户的年龄
  • 必需:真

@ApiModelProperty 用于为模型添加属性。您将在模型属性的模型类中使用它。

例:

模型用户具有名称和年龄作为属性:名称和年龄,然后对于每个属性,您可以定义以下内容:

对于年龄:

  • 类型: 整数,
  • 格式“: int64,
  • 描述: 用户的年龄,

查看 swagger 对象中每个字段表示的字段:

@ApiModelProperty- https://github.com/OAI/OpenAPI-Specification/blob/master/versions/1.2.md#529-property-object

@ApiParam - https://github.com/OAI/OpenAPI-Specification/blob/master/versions/1.2.md#524-parameter-object


答案 2

推荐