openapi3-如何提出错误的请求示例

时间:2019-09-12 10:42:18

标签: api swagger openapi

在openapi3-format中,如何为错误请求指定示例? 我是这样假设的,但是显然从响应到参数块的所有示例都应该放在响应的一个示例块中?

对于错误的请求,我的意思是一个示例,该示例的数据导致另一个状态码为200。

就IDE所知,下面的示例似乎是有效的,但并非按预期运行。一些工具甚至认为这是错误的。

  • 当我使用swaggerhubprism模拟它时,无论我为good参数提供什么内容,我都只能得到a-示例 1` 200回复​​
  • 与邮递员模拟服务器相同
  • 例如,当我尝试使用API Blueprint 1A将其转换为APImatic格式,以Snowboard进行模拟时,我在示例语法中遇到了错误。熟悉其他几种工具。
paths:
  /test:
    get:
      summary: test

      parameters:
        - in: query
          name: a
          examples:
            good:
              value: 1
            bad:
              value: 0
            good2:
              value: 2


      responses:
        "200":
          description: good
          content:
            text/plain:
              examples:
                good:
                  value: "good example 1"
                good2:
                  value: "good example 2"

        "401":
          description: bad
          content:
            text/plain:
              examples:
                bad:
                  value: "bad example"

0 个答案:

没有答案