招摇未呈现请求正文

时间:2018-10-31 07:20:00

标签: yaml swagger openapi swagger-editor

我有以下与openapi 3.0兼容的yaml文件,我正在尝试通过招摇来渲染。 yaml文件中未报告任何错误,但是requestBody并未在全面的GUI上呈现。我只是得到一个parameters字段,该字段为空,但未为请求正文呈现任何内容,也没有收到任何错误。下面的屏幕截图。

paths:
  /my-api:
    post:
      summary: My API Summary
      description: My API Description
      tags:
        - Cost Center
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                data:
                  type: array
                  items:
                    $ref: '#/components/schemas/ReqBodyStruct'

Screnshot

以什么方式获得同时显示在swagger gui中的RequestBody?我想念什么吗?

2 个答案:

答案 0 :(得分:1)

根据Swagger UI github页面上的这两个问题OAS 3.0: Support for media type examples (aka request/response body examples) #3437Examples are not showing #2651,此问题应该在版本3.23.0(2019年6月29日)中得到解决。

答案 1 :(得分:0)

确保使用正确的规格版本。在我将请求从openapi: "3.0.2"更改为openapi: "3.0.0"

之后,请求主体向我显示了