swagger - 使 AutoRest 将类映射到响应中的子对象

Question

我正在尝试将客户端写入大型非 Swagger 记录的 API，并认为为其编写 swagger.json 并使用 AutoRest 将是实现此目的的好方法。案例是这个 API 将每个操作的响应数据包装到一个带有控制信息的更大对象中，如下所示：

{
    "resp_code": "SUCCESS",
    "caller_ref": "2016111116233156169531",
    "server_ref": "2016111116233189512798",

    "data": {
        "id": "idstring",
        "name": "nameString",
        "address": "addressString",
        ...
        }
}

在这种情况下，“数据”将是我们的“客户”定义。有没有办法定义 200 OK 响应模式和 swagger.json 文件中的定义，以便 AutoRest 将此“数据”映射到客户端类？

Answer 1

实际上答案很简单，我所要做的就是像这样编写 swagger 文件的“响应”对象：

"responses": {
                "200": {
                    "description": "successful operation",
                    "schema": {
                        "type": "object",
                        "properties": {
                            "data": {
                                "$ref": "#/definitions/Client"
                            }
                        }                            
                    }
                }
            }

除了创建Client定义。AutoRest 生成检索“数据”对象的代码，从而可以访问其中的客户端。