RAML 1.0 Example DataType 的具体示例

Posted 2023-02-19

【中文标题】RAML 1.0 Example DataType 的具体示例

【英文标题】：Concrete example of RAML 1.0 Example DataType

【发布时间】：2021-11-18 02:25:19

【问题描述】：

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

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

【问题讨论】：

你的意思是有一个数据类型的例子吗？

或者如何在 DataType 定义中使用示例？

@aled 我的意思是示例的数据类型（通常我尝试使用 Json 和 Xml，但我想要一种方法来定义它，如正确的示例数据类型。如此处所述。file:///var/folders/y5 /9zqmn74j5dzdz3g7_b569gb00000gp/T/TemporaryItems/NSIRD_screencaptureui_ealFNK/Screenshot%202021-09-27%20at%2012.13.35%20AM.png

我认为您不能将屏幕截图附加到 cmets，并且在堆栈溢出中使用屏幕截图作为源代码是一种不好的做法。正确的方法是编辑您的问题并将 sn-ps 添加为文本。

@aled 是的。实际上我试图在评论中粘贴链接，但它没有用。现在我已经粘贴了截图。

【参考方案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，该页面还描述了尝试错误使用示例时的一些常见错误以及如何解决这些错误。

【讨论】：

感谢@aled 的详细回答。现在已经很明白了。非常感谢！！！

@RizwanShakoor 欢迎您。请随时接受/投票以将其标记为对其他用户有用。

是的。如果你也请看看这个。看起来 RAML 不支持可选的 UrlParameters。 ***.com/questions/69345425/…