覆盖Swagger UI中的动词级模型/模型模式

Question

我正在使用swagger ui，试图标准化API文档。我意识到，对于使用主体参数因而需要显示模型和模型模式的动词（GET、PUT、POST等），模式是在资源级别定义的（在pet store示例中为/pet或/store）。然而，在我们的API中，所需的主体参数将随着动词的变化而变化，最好为每个动词建立一个模型来准确反映这一点。

中模型定义的当前版本http://petstore.swagger.wordnik.com/api/api-docs/pet，其中模型定义如下：

有什么方法可以在动词级别覆盖默认资源级别模型吗？

Answer 1

在swagger 2.0规范中，每个资源都有HTTP方法的子部分（get、post、删除等）。其中每个都有一个参数标签，该标签映射到下面形式的JSON对象列表。为了让该主体使用单独的模式，可以使用模式标签和$ref子标签覆盖它，然后引用您在底部的定义小节中单独提供的定义。

{
    name: "body",
    in: "body",
    description: "set the properties of a pet",
    schema: {
        $ref: "#/definitions/PetPut"
    },
    required: true
}