Openapi3 和 CSV 响应（针对 Dredd）

Question

我用DREDD测试我的Api，因为它的规范（考虑到Dredd在Openapi3中编写的痛苦限制）。否 我有一个终结点，如果 Accept 标头设置如此，它将生成 CSV 数据。

    '/my-endpoint':
        summary: ...
        description: ...
        get:
 #          parameters:
 #              - 
 #                  in: header
 #                  name: Accept
 #                  description: "Response format: application/json or text/csv"
 #                  example: "text/csv"
            responses:
                '200':
                    description: ...
                    content:
                        text/csv:
                            schema:
                                type: string
                            example:
                                summary: 'csv table'
                                value: 'cell1, cell2'

当我用Dredd运行测试时，测试失败

expected: 
headers: 

body: 
[
  {
    "key": "summary",
    "value": "csv table"
  },
  {
    "key": "value",
    "value": "cell1, cell2"
  }
]
statusCode: 200

warn: API description parser warning in .../tmp/transformed.specs.yml: 'Parameter Object' 'name' in location 'header' should not be 'Accept', 'Content-Type' or 'Authorization'

我在这里和这里阅读：不允许名为“接受”，“内容类型”和“授权”的标头参数。要描述这些标头，请使用相应的 OpenAPI 关键字 - 但它们是什么？根据此页面和此页面，似乎足以指定给定类型的响应，但这显然不足以告诉Dredd生成这样的标头。

Answer 1

您收到错误，因为示例键的值意味着是文本示例值。因此，在您的情况下，它被视为具有摘要和值属性的对象。

将您的定义更改为：

                    content:
                        text/csv:
                            schema:
                                type: string
                            example: 'cell1, cell2'

或者，如果您想提供示例的摘要/说明，请使用示例：

                    content:
                        text/csv:
                            schema:
                                type: string
                            examples:
                                csv table:
                                    summary: A CSV table with 2 cells
                                    value: 'cell1, cell2'