Swagger-指定可选对象属性或多个响应

Question

我有一个API，成功后返回以下响应：

{
    "result": "success",
    "filename": "my-filename.txt"
}

或者在失败时像下面这样：

{
    "result": "error",
    "message": "You must specify the xxx parameter."
}

只有在请求成功时才会指定filename属性，但如果出现错误，则会提供消息。这意味着消息和文件名属性是“可选的”，但结果属性是必需的。

我尝试在定义中定义这个响应对象，如下所示：

"my_response_object": {
    "type": "object",
    "properties": {
        "result": {
            "type": "string",
            "description": "value of 'success' or 'error', indicated whether was successful",
            "required": true
        },
        "message": {
            "type": "string",
            "description": "an error message if there was an issue",
            "required": false
        },
        "filename": {
            "type": "string",
            "description": "the filename to return if the request was successful",
            "required": false
        }
    }
}

但似乎swagger不喜欢“必需”属性，并将显示以下错误消息：

当我看一个来自swagger的例子时，他们有以下布局，其中有两个不同的响应定义，而不是一个。

"responses": {
    "200": {
        "description": "Profile information for a user",
        "schema": {
            "$ref": "#/definitions/Profile"
        }
    },
    "default": {
        "description": "Unexpected error",
        "schema": {
            "$ref": "#/definitions/Error"
        }
    }
}

我可以这样做，但是对于200个错误代码，似乎一个不能有多个响应。这是否意味着必须对所有错误响应使用“default”，并且只能对所有错误响应使用单个结构，或者是否有方法指定某些属性在定义中是可选的？

Answer 1

您将在模型中得到错误，因为这不是定义所需属性的方法。

正确的形式是：

    "my_response_object": {
        "type": "object",
        "required": [ "result" ],
        "properties": {
            "result": {
                "type": "string",
                "description": "value of 'success' or 'error', indicated whether was successful"
            },
            "message": {
                "type": "string",
                "description": "an error message if there was an issue"
            },
            "filename": {
                "type": "string",
                "description": "the filename to return if the request was successful"
            }
        }
    }

假定required属性中没有的任何内容都是可选的。请记住，这意味着可以同时获取消息和文件名。

然后，您可以将此模型用于200响应。

然而，当涉及RESTAPI设计时，这打破了一个更常见的标准。从HTTP协议获取的状态代码旨在传达操作的结果。2XX用于成功响应，4XX用于错误用户输入导致的错误，5XX用于服务器端的问题（3XX用于重定向）。你在这里做的是告诉客户——操作成功了，但事实上，这可能是一个错误。

如果您仍然可以修改API，我强烈建议您使用状态代码进行区分，即使使用微调的区分，例如200表示成功的GET操作，201表示成功的POST（或创建）操作等等，基于这里的定义-http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html.