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。