api和模型招摇之间的差异

Question

我是一个狂热的新手，我正在定义一个API。

我可以使用swagger定义api而无需使用@ApiModelProperty注释吗？什么是swagger中的对象模型究竟是什么？

Answer 1

是的，您可以在不使用@ApiModelProperty的情况下定义API。模型对象不是OpenAPI规范中的必填字段。

  

模型对象包含每个模型定义的字段，这与规范中其他对象的结构不同。它遵循JSON-Schema规范的一个子集。

@ApiModelProperty定义该对象的属性。模型对象也是Swagger

中响应的一部分

示例您有一个模型 - User类。

 class User {
   int id;
   String name;
   int age;
 }

模型对象将包含有关用户的信息。

{
"User": {
  "id": "User",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64"
    },
    "name": {
      "type": "string"
    },
   "age": {
      "type": "integer"
    }
  }
 }
}

@ApiModelProperty在Java类User中用于通过定义其中的id，name和age来生成此JSON。