api - RAML 默认信封

Question

我的 API 有一个用于所有集合类型资源的默认信封，如下所示:

{
  "data": [{},{},{}],
  "self": "http://api-url/members",
  "total": 120,
  "limit": 10,
  "offset": 0
}

是否可以使用 RAML 来定义它？在资源类型中？怎么办？

Answer 1

这取决于您使用什么来指定 API 的实体:

• JSON Schema Draft 3 - 使用这些公共(public)字段创建基本模式，并在每个具体模式中使用extends 机制，
• JSON Schema Draft 4 - 使用这些公共(public)字段创建共享模式，并使用 allOf 机制将其混合到每个具体模式中，
• RAML 1.0 类型 - 创建一个通用类型并通过 type 属性在每个具体类型中引用它。