
raml模板
为RESTful API端点定义示例主体有效负载和响应是设计现代API的重要方面。 这些示例确保了API合约期望从客户端接收并响应客户端的内容。
在本文中,我将通过示例重点介绍四种指定期望的传入和传出主体的方法。
内联作为正文示例
在根RAML中使用关键字example
(单数)显式地包含示例,后跟example
的JSON或YAML表示形式。 请参见以下示例中的第10行。
包括多个YAML / JSON示例
使用!include
关键字引用包含示例的文件。 您必须使用examples
(多个)并为示例唯一命名。 在这种情况下,示例被命名为ex1
和ex2
。 请参见下面的示例中的第16/17行。
包括一个NamedExample RAML
引用一个NamedExample RAML文件,该文件以RAML格式定义了示例。 您必须使用examples
(复数)关键字,并且可以提供一个或多个示例。 请参见下面示例中的第22行。

提供示例作为简单文本消息
使用example
(单数)关键字后跟一条文本消息。 请参见下面示例中的第29行。
完整代码段
下面的RAML代码片段显示了将示例添加到上面讨论的规范中的四种方法。

RESTful API设计的五项原则
在编写API规范之前,必须考虑RESTful API规范的五个主要方面。 通过RESTful API设计了解更多信息。
raml模板