系统API设计方法

Question

我想设计系统API，这将与REST服务连接使用RAML的医疗保健领域。后端Rest服务将有GET/POST请求。GET/POST请求通常服务于getCollection/getById/getByName。

我如何开始设计RAML？哪种方法是最好的、最标准的？任何人都可以在下面的项目中帮助我。用于命名Process/System/Experience API的命名约定。URI设计任何其他体系结构建议。

谢谢，Vijay D

Answer 1

关于RAML，我建议下面的教程是非常有用的，并用示例进行了很好的解释。

https://raml.org/developers/raml-100-tutorial
https://raml.org/developers/raml-200-tutorial

您也可以在下面的url中查看raml规范。

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

关于命名约定和设计。这些都是非常宽泛的主题。我建议从mulesoft下载的这本书是一个很好的开始。

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

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

https://www.mulesoft.com/ebook