代码之家 › 专栏 › 技术社区 › GluePear

招摇过市与相关对象响应

openapi api-design swagger-ui swagger

GluePear · 技术社区 · 6 年前

我正在使用SwaggerHub和OpenAPI 3来定义API。一条路线 GET /foo/{id] ,应返回 foo 给定对象 id ,及其关联 bar {id: 4, name: 'test', bars: [{id: 53, name: 'barName1'}, {id: 87, name: 'barName2'}]} .也就是说,在和

我如何用OpenAPI 3语法描述这一点?我试过用 anyOf

paths:
  /foo/{id}:
    get:
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items: 
                  $ref: '#/components/schemas/Foo'
                anyOf:
                  - $ref: '#/components/schemas/Bar'

但这似乎没有在用户界面中显示正确的模式(没有提到 Bar

1 回复 | 直到 6 年前

Helen 6 年前

你不需要 anyOf . 任何 表示另一个选项(“foo或bar”),而您有一个常见的嵌套结构-一个对象 Foo 与财产 bars 这是一系列 Bar S.这可以描述为:

      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Foo'

components:
  schemas:
    Foo:
      type: object
      properties:
        bars:
          type: array
          items:
            $ref: '#/components/schemas/Bar'
      required:
        - bars
    Bar:
      ...

推荐文章

Andres Ramirez · .antMatchers(“/招摇过市ui/**”)。permitAll()错误405

2 年前

isADon · Spring Boot&Swigger用户界面。设置JWT令牌

6 年前

Ankur Verma · 在Docker映像中使用本地json文件运行Swagger

6 年前

saimonsez · swagger ui不使用自定义XML ObjectMapper

6 年前

Daniel Netzer · Swagger ui express模块,仅实例化最后定义的文档

6 年前

Sunny Agarwal · 通过unpkg加载swagger ui时,没有为“StandaloneLayout”错误定义布局

6 年前

Steffen Harbich · 使用ZoneId和jackson-datatype-jsr310时,Swagger UI会显示嵌套的模型对象

6 年前

Casey Crookston · 新添加的API参数未在Swagger中显示

6 年前

Tibberzz · 从Swagger UI自动生成客户端代码

6 年前

Paul Wild · 使用路由属性和查询参数时Web api2的招摇过市文档

6 年前