尝试导入JSON时出现Swagger错误

时间:2016-04-22 15:06:00

标签: swagger swagger-2.0

我使用查询参数成功定义了API,但希望通过JSON对象传递所有状态。

我已经定义了以下YAML文件:

paths:
  /contact-us:
    post:
      summary: Contact Us
      description: |
        Originates a new conversation thread 
      consumes:
        - application/json
      parameters:
        - in: body
          required: true
          schema:
            $ref: '#/definitions/RequestConversation'
      tags:
        - Email
      responses:
        200:
          description: New conversation has been originated
          schema:
            $ref: '#/definitions/Conversation'

这会导致parameters行出错:

  

数据与' oneOf'

中的任何架构都不匹配

但我在同一个YAML文件中有以下定义:

definitions:
  RequestConversation:
    type: object
    properties:
      company_id:
        type: string
        # required: true
      user_email:
        type: string
        # required: true
      type:
        type: string
        # required: true
        default: 'contact-us'
      sub_type:
        type: string
      campaign:
        type: string

还要注意"要求"定义被注释掉了,因为他们给了我一个不同的错误:

  

预期类型数组但找到类型boolean

有人可以帮忙吗?

1 个答案:

答案 0 :(得分:0)

好的解决了我自己的问题(至少第一部分)。希望这会让其他人受益:

  1. 第一个问题实际上就是我没有指定一个"名称"属性是必需的。

  2. 这仍然是开放的(也就是说,它可以工作,但不能使用"必需的"属性)。