在 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

看看这个。希望对你有帮助。