RAML简介

最新推荐文章于 2024-11-23 14:54:02 发布

原力架构

最新推荐文章于 2024-11-23 14:54:02 发布

阅读量1.7k

点赞数 1

CC 4.0 BY-SA版权

分类专栏： API设计文章标签： raml api设计

本文链接：https://blog.youkuaiyun.com/github_35758702/article/details/53379298

RAML是一种RESTful API建模语言，基于YAML，便于API设计、模拟、反馈收集和文档生成。它促进了API生命周期管理，允许在编码前进行建模，并有丰富的周边工具如API Workbench和API Designer支持设计、构建、测试和分享。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

RAML是什么

Write once. Use many. Creative laziness encouraged
RESTful API Modeling Language (RAML) makes it easy to manage the whole API lifecycle from design to sharing. It’s concise - you only write what you need to define - and reusable. It is machine readable API design that is actually human friendly.

RAML的全称是RESTful API Modeling Language，这是一种用来描述基于Restful架构的API（设计API）的语言。它的语法规范是基于YAML的新规范，因此机器与人类都能够轻易地理解其中的内容。

但是，仅仅简单地创建一个原型是不够的。MuleSoft创建了一种API契约设计周期图，这一设计的前提在于API不仅仅是机器之间的一种契约，同样也是提供商与用户之间的一种契约。

在API设计后，可以对外提供模拟的API调用，这样就能从API使用者那得到具体反馈。这些有价值的反馈能够让公司找到设计中的缺陷，例如数据或结构中的不一致性，以及API中的一些令人困惑之处。在这一阶段及时发现设计中的问题非常关键，因为一旦你的API发布之后需要修改，那么在大多数情况下都会破坏向后兼容性，而这将影响API的使用。

这里就不对RAML的具体语法做说明了，在我的另一篇文章《