How to receive a dynamic response in a Swagger spec

我们两清 提交于 2019-12-10 17:34:21

问题


I want to request a table from my database through my API. However, I don't know what number of columns the table will have, or what it will contain. How can I specify this in Swagger? This is what I would like to do:

paths:
  /reports/{id}:
    get:
      summary: Detailed results
      description: filler
      parameters:
        - name: id
          in: path
          description: filler
          required: true
          type: integer
          format: int64
      responses:
        200:
          description: OK
          schema:
            type: array
            items: 
              $ref: '#/definitions/DynamicObject'
definitions:
  DynamicObject:
    type: object
    properties:
      **$IDONTKNOWWHATTODO**

Any ideas on how to define a JSON object with no specific parameters?


回答1:


To describe arbitrary JSON, please use "type": "object". Here is an example in JSON:

    "responses": {
      "200": {
        "description": "successful operation",
        "schema": {
          "type": "object"
        }
      }
    },


来源:https://stackoverflow.com/questions/35782175/how-to-receive-a-dynamic-response-in-a-swagger-spec

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!