如何在成功的 GET 响应中记录多种内容类型

Question

假设我们有一个示例 json swagger 规范：

{
"swagger": "2.0",
"info": {
    "version": "1.0.0",
    "title": "Some API"
},
"basePath": "/api/v1",
"consumes": [
    "application/json"
],
"produces": [
    "application/json",
    "text/csv"
],
"paths": {
    "/some/endpoint": {
        "get": {
            "parameters": [
                {
                    "in": "body",
                    "name": "body",
                    "required": false,
                    "schema": {
                      "$ref": "#/definitions/BodyParamsDefinition"
                    }
                }
            ],
            "responses": {
                "200": { ?? } ...

可以制作两种内容类型：

application/json
text/csv

GET /some/endpoint 的默认响应是一个 csv 文件，但如果像这样使用 format 查询参数 /some/endpoint?format=json，响应将采用 json 格式。

我找不到如何以正确的响应完成我的说明。当我使用这种方法时：https://swagger.io/docs/specification/describing-responses/ 我收到验证错误：...get.responses['200'] should NOT have additional properties

Answer 1

您快完成了，您只需要为响应定义一个 schema。此 schema 定义与此状态代码关联的所有内容类型的响应结构。

例如，如果操作 returns 这个 JSON:

[
  {
    "petType": "dog",
    "name": "Fluffy"
  },
  {
    "petType": "cat",
    "name": "Crookshanks"
  }
]

和这个 CSV：

petType,name
dog,Fluffy
cat,Crookshanks

你会使用：

# YAML
responses:
  200:
    description: OK
    schema:
      type: array
      items:
        type: object
        properties:
          petType:
            type: string
          name:
            type: string

更多信息：Describing Responses

在 OpenAPI 3.0 中，内容类型定义得到改进，模式可以因内容类型而异：

openapi: 3.0.0
...

paths:
  /some/endpoint:
    get:
      responses:
       '200':
          description: OK
          content:
            # JSON data is an object
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
            # CSV data is a string of text
            text/csv:
              schema:
                type: string

Default response for GET /some/endpoint is a csv file, but if the format query param is used like this /some/endpoint?format=json, the response would be in json format.

目前无法将特定响应映射到特定操作参数，但 OpenAPI 规范存储库中有几个相关提案：

如何在成功的 GET 响应中记录多种内容类型

How to document multiple content types in successful GET response in swagger

json

swagger

swagger-ui