首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >在OpenAPI 3.0中,有没有一种方法来描述两种不同的响应类型?

问在OpenAPI 3.0中,有没有一种方法来描述两种不同的响应类型?
EN

Stack Overflow用户
提问于 2018-05-18 01:36:33
回答 1查看 1.2K关注 0票数 5

我想要做的是指定API调用的响应有时可能是PDF文档,有时可能是JSON。我想用OpenAPI 3.0格式做这件事。对于PDF,响应将如下所示:

代码语言:javascript
复制
      responses:
        '200':
          description: An invoice in PDF format.
          content:
            application/pdf:
              schema:
                type: string
                format: binary

在JSON响应的情况下,这将描述响应:

代码语言:javascript
复制
      responses:
        '200':
          description: A JSON object containing user name and avatar
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Invoice" 

JSON (https://swagger.io/docs/specification/describing-responses/)提供了以下示例,说明如何指定几个不同的JSON中的一个可以作为对特定OAS3调用的响应。这几乎就是我想要的,除了不描述不同可能的JSON模式之外,我想指定不同的可能的内容类型,如上所述。有没有办法在OAS3格式中做到这一点?

代码语言:javascript
复制
      responses:
        '200':
          description: A JSON object containing pet information
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/Cat'
                  - $ref: '#/components/schemas/Dog'
                  - $ref: '#/components/schemas/Hamster'
EN

回答 1

Stack Overflow用户

发布于 2018-05-18 01:40:48

我发现这是可行的:

代码语言:javascript
复制
responses:
    '200':
      description: "An invoice."
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/Invoice"
        application/pdf:
          schema:
            type: "string"
            format: "binary"

请参阅此处的“响应媒体类型”部分:https://swagger.io/docs/specification/describing-responses/

票数 5
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/50397427

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档