系统API设计方法

Question

我想设计System API，它将使用RAML for Healthcare域连接REST服务。 后端休息服务将有GET / POST请求。 GET / POST请求通常会提供getCollection / getById / getByName。

我如何开始接近设计RAML？ 这是最好和最标准的方法吗？ 任何人都可以帮助我以下项目。 用于命名Process / System / Experience API的命名约定。 URI设计 如果你想添加任何其他建筑建议。

谢谢， Vijay D

Answer 1

关于RAML我建议下面的教程非常有用，并且用exmaples

进行了很好的解释

https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md

您还可以查看以下网址的raml规范

https://www.mulesoft.com/lp/ebook/api/restbook

关于命名约定和设计。这些是非常广泛的主题。我建议下面的书可以从mulesoft下载，是一个很好的起点。

https://www.mulesoft.com/ebook

此处是电子书资源的链接，在底部，您可以看到所有资源部分，它可以帮助您探索不同的领域。

{{1}}