在Swagger JSON示例中包含根元素

Question

在我们的REST API中，我们同时支持XML和JSON作为输入/输出格式，并且在生成Swagger文档时，Swagger生成的示例输入未显示JSON输入的根节点值，但它是针对XML样本的。

由于我们的REST API也期望JSON的根节点，我如何让Swagger在样本中显示根节点？

Swagger示例XML -

<Request>
    <EmployeeNumber>string</EmployeeNumber>
    <Department>
            <DepartmentId>string</DepartmentId>
            <DepartmentName>string</DepartmentName>
            <DepartmentHead>string</DepartmentHead>
            <DepartmentLocation>string</DepartmentLocation>
    </Department>
</Request>

Swagger示例JSON -

{
    "EmployeeNumber": "string",
    "Department": {
      "DepartmentId": "string",
      "DepartmentName": "string",
      "DepartmentHead": "string",
      "DepartmentLocation": "string"
    }
  }

预期的JSON样本 -

{
  "Request": {
    "EmployeeNumber": "string",
    "Department": {
      "DepartmentId": "string",
      "DepartmentName": "string",
      "DepartmentHead": "string",
      "DepartmentLocation": "string"
    }
  }
}

如何在swagger注释中提供示例示例而不是自动生成一个？

Answer 1

https://github.com/swagger-api/swagger-core/wiki/annotations

看看这个。希望它会对你有所帮助。