RAML:将示例属性添加到包含的json模式类型

时间:2015-12-07 14:50:18

标签: json raml

我想将自定义对象定义为json模式文件,并将相关示例定义为单独的文件。我想做这样的事情:

#%RAML 1.0
title: MDM
version: v1
baseUri: http://api.mdm.ishafoundation.org
mediaType: application/json
types:
  Contact:
    type: !include schemas/contact.json
    example: !include examples/contact.example.json

但是我收到以&#34开头的行的以下错误消息:type:"声明 - "错误:您不能继承两种不同类型的"

在规范中说

  

外部类型不能参与类型继承或专门化。换句话说:您无法定义声明新属性或设置构面的外部类型的子类型。但是,您可以创建简单的类型包装器,以添加元数据,示例和描述。

我猜这是问题所在。但我不知道创建一个"类型的包装器"意味着什么。有人能告诉我实现我想要的最好方法是什么。

1 个答案:

答案 0 :(得分:1)

RAML规范显示的示例与您在此处发布的内容完全相同,因此它应该可以正常运行,或者规范中存在错误。

无论如何,这种写RAML的方式有效:

#%RAML 1.0
title: MDM
version: v1
baseUri: http://api.mdm.ishafoundation.org
mediaType: application/json
types:
 Contact: !include schemas/contact.json

不确定如何在那里放置示例,但您始终可以将其直接添加到方法中。