挥舞着不显示用户界面中的对象属性

时间:2018-09-18 11:06:52

标签: api swagger swagger-editor

我正在为API做文档。
目前,我有:

/script/update:
post:
  tags: 
  - "Script"
  summary: Update a script
  operationId: updateScript
  responses:
    '200':
      description: OK
    "404":
      description: Not Found
  requestBody:
    description: A script object in order to make the request
    required: true
    content:
      application/x-www-form-urlencoded:
        schema:
          type: object
          properties:
            subsite_id:
              type: string
            script:
              type: object
              properties:
                script:
                  $ref: '#/components/schemas/ScriptType'
                type:
                  type: string
                  enum:
                    - custom
                    - interface
                    - freshbot
                    - feeder
                    - getter
                    - smcf
                status:
                  $ref: '#/components/schemas/ScriptStatus'
                comment:
                  type: string
                  format: string
                reason:
                  type: string
                  format: string

当我尝试使用UI时出现问题。 唯一出现的是以下内容: enter image description here 我想要的是,脚本对象可以像subsite_id一样,逐个字段填充其具有的每个属性。我想念什么。

1 个答案:

答案 0 :(得分:0)

Swagger UI 3.x没有用于JSON对象的表单编辑器,因此所有JSON数据都需要以JSON格式输入:{ "prop": value, ... }

以下是您可以跟踪的相应功能请求:
https://github.com/swagger-api/swagger-ui/issues/2771