使用多行定义响应的模式

时间:2016-09-08 22:58:03

标签: schema response raml

我是RAML的新手。我正在尝试为包含多行的响应定义一个模式,就像SQL中的结果集一样。我已经这样做了,但只是针对一行回复。

我也想定义一个例子。

你能帮我提一些如何实现这个目标的例子吗?

非常感谢

1 个答案:

答案 0 :(得分:1)

以下是内联架构的示例: -

#%RAML 0.8
title: A one-song API
/{songId}:
  get:
    body:
      application/json:
        schema: |
          {
            "$schema": "http://json-schema.org/schema",
            "type": "object",
            "description": "The canonical song representation",
            "properties": {
              "title":  { "type": "string" },
              "artist": { "type": "string" }
            },
            "required": [ "title", "artist" ]
          }

|管道符号,允许跨越多行跨越字符串标量 参考: - https://github.com/raml-org/raml-spec/issues/8