api和模型招摇的差异

Question

我是新来的，我正在定义一个API。

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

Answer 1

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

Models对象为每个模型定义保存一个字段，这与规范中的其他对象的结构不同。它遵循JSON模式规范的一个子集。

@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，姓名和年龄产生这种JSON。