Question

我有一个RAML文件，其中包含一个自定义的BooleanValue json模式作为方法的返回类型。

BooleanValue.json：

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "Boolean value",
    "description": "If lookup or update in success",
    "type": "boolean"
}

Service.raml代码段：

#%RAML 1.0
title: Service API
version: 1.0
mediaType: application/json
schemas:
  - BooleanValue:  !include model/BooleanValue.json

<... snip ...>

/resource:
  /{name}:
    patch: 
      responses: 
        200:
          body:
            schema: BooleanValue
            example: true

我确信不需要定义BooleanValue架构，但是我找不到如何指示JSON布尔类型是返回值的示例。

可以这样做吗？怎么样？

Answer 1

使用RAML 1你可以这样做：

#%RAML 1.0
title: Service API
version: 1.0
mediaType: application/json
/resource:
  /{name}:
    patch: 
      responses: 
        200:
          body:
            description: If lookup or update in success
            type: boolean
            example: true

在RAML中将JSON布尔类型定义为RESTful主体类型

1 个答案: