如何使用 swagger/OpenAPI 指定替代响应格式? [英] How to specify alternative response formats with swagger/OpenAPI?

问题描述

我有一个 swagger.yaml 是这样的:

I have a swagger.yaml something like this:

swagger: "2.0"
paths:
  /something:
    get:
      parameters:
        - name: format
          in: query
          type: string
          pattern: '^(csv|json|xml)$'
      responses:
        200:
          schema:
            type: ?

我想根据 format 查询参数的值(例如 localhost/api/something?format=csv)返回不同的格式(csv、json、xml).

And I want to return different formats (csv, json, xml) depending on the value of the format query parameter (eg. localhost/api/something?format=csv).

如何在规范中指定不同的响应格式?

How can I specify the different response formats in the spec?

推荐答案

我找到了一种解决方法，通过提供不同的端点:

I found a workaround, by providing different endpoints:

swagger: "2.0"
paths:
  /something/json:
    get:
      produces:
        - application/json
      responses:
        200:
          schema:
            type: object
            properties:
              ...
  /something/csv:
    get:
      produces:
        - text/csv
      responses:
        200:
          schema:
            type: string          

注意每个 get 内部的不同 produces:，而顶层没有.

Note the different produces: inside each get, and none at the top level.

csv 端点的实际响应标头是:

The actual response header for the csv endpoint is:

Content-Length:64
Content-Type:text/csv; charset=utf-8
Date:Fri, 26 Aug 2016

我也尝试在 yaml 中添加标头(直接在上面的代码之后)，但它不会更改实际的响应标头:

I have also tried adding headers to the yaml (straight after the code above), but it doesn't change the actual response header:

          headers:
            Content-type:
              type: string
              description: text/csv; charset=utf-8
            Content-Disposition:
              type: string
              description: attachment; filename=data.csv

在任一端点我都会收到一条控制台消息(我正在使用 connexion 构建它):

At either endpoint I get a console message (I am building this using connexion):

资源解释为 Document，但使用 MIME 类型 application/json 传输，或

资源被解释为 Document，但使用 MIME 类型 text/csv 传输

此外，csv 被解释为要下载的文件，不会显示在浏览器中.

Also, the csv is interpreted as a file to download, not displayed in the browser.

...所以我怀疑我还没有完全正确.

...so I suspect I haven't quite got it right yet.

这篇关于如何使用 swagger/OpenAPI 指定替代响应格式?的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！