RAML 1.0 Example DataType 的具体示例

Question

我没有找到任何合适的示例，其中示例在主 RAML 文件中正确用作 DataType。大多数情况下，它被用作 .json/.xml 文件。是否有任何适当的细节或参考可以找到。使用 AnyPoint 平台设计中心构建 RAML。

下面粘贴选择点的截图，我们可以选择Example作为DataType。

Answer 1

文档中有一个专门介绍定义示例方法的页面 (Guide to Defining Examples in RAML 1.0)。我想所要求的是如何使用 NamedExample 的示例：

api.raml:

#%RAML 1.0
title: test
types:
  A:
    properties:
      givenName: string
      familyName: string
    examples: !include fragment.raml

fragment.raml：

#%RAML 1.0 NamedExample
fullName:
  givenName: ”Chiaki”
  familyName: "Mukai"

otherFullName:
  givenName: "Kyung-won"
  familyName: "Park"

我建议您还阅读页面Common Problems Found in RAML 1.0 API Specifications，该页面还描述了尝试错误使用示例时的一些常见错误以及如何解决这些错误。