2024年4月27日发(作者：)
RAML 规范研究
1 RAML是什么
RAML（RESTful API Modeling Language 即RESTful API建模语言）是对RESTful API的一种简
单和直接的描述。它是一种让人们易于阅读并且能让机器对特定的文档能解析的语言。RAML
是基于YAML，符合1.2版本规范，能帮助设计RESTful API和鼓励对API的发掘和重用，依
靠标准和最佳实践从而编写更高质量的API。通过RAML定义，因为机器能够看得懂，所以
可以衍生出一些附加的功能服务，像是解析并自动生成对应的客户端调用代码、服务端代码
结构， API说明文档。
我们知道Web Service有相应的WSDL来描述它相应的Schema，WSDL就相当于对当前
的服务做了一个描述，Client端可以据此生成相应的Proxy代码, 因此WSDL可以帮助Client
更容易的消费服务。对于RESTful API，却没有相应的“REST WSDL”，在这种情况下，RAML
应运而生，它可以对我们的API做完整的描述，不管是对人或者是机器，都能以相对友好的
方式使用。
shiyuanstone 2014年10月8日
2 RAML规范
2.1 RAML文件构成
上图是一个RAML一个简单的例子。下面介绍一下RAML的基本语法。完成一个RAML
具体步骤参见：/
整个RAML文档可简单划分为“版本声明”、“API元数据定义”、“公用属性定义”和“资
源方法定义”四部分构成。
元素 说明 示例
shiyuanstone 2014年10月8日
发布者：admin，转转请注明出处：http://www.yc00.com/news/1714205183a2401794.html
评论列表（0条）