RAML 1.0类型问题

时间:2016-06-02 08:39:51

标签: raml

我遇到RAML 1.0类型的问题。 Validator给出了位置错误:0和is_archive:false表示整数和布尔值是例外。当我使用特征时会发生错误。

types:
  CatalogObject:
    type: object
    properties:
      id: number
      title: string
      position: integer
      is_archive: boolean

/catalog:
  get:
    responses:
      200:
        body:
          type: CatalogObject
          examples: [{
            id: 1,
            title: Simple1,
            position: 5,
            is_archive: true
          }, {
            id: 2,
            title: Simple2,
            position: 0,
            is_archive: false
          }]

例如:

traits:
  catalogItem:
    responses:
      404:
        description: 404 Not Found

当我删除该代码时,一切正常。

1 个答案:

答案 0 :(得分:1)

我使用的验证器确定了响应定义的一些问题。一旦错误得到解决,traits就会编译而没有错误。

  1. body需要mime-type
  2. 如果您期望数组响应,如示例所示,响应type应为数组。

    type: CatalogObject[]

  3. examples关键字,如果选择使用它而不是example,则支持多个示例,因此正文应该是一个字典,每个示例都有一个键:

  4. /catalog:
      get:
        responses:
          200:
            body:
              application/json:
                type: CatalogObject[]
                examples:
                  first_example:
                    [{
                      id: 1,
                      title: Simple1,
                      position: 5,
                      is_archive: true
                    }, {
                      id: 2,
                      title: Simple2,
                      position: 0,
                      is_archive: false
                    }]