App后台开发运维和架构实践学习总结(7)——RESTful API 设计规范

xiaoxiao2021-02-28  98

一个好的API设计,是应该遵循资源导向的,需要见名知义。

一、协议

API与用户的通信协议,总是使用HTTPs协议。

二、域名

应该尽量将API部署在专用域名之下。

https://api.example.com

如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下。

https://example.org/api/

三、版本(Versioning)

应该将API的版本号放入URL。

https://api.example.com/v1/

另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便和直观。Github采用这种做法。

四、路径(Endpoint)

路径又称"终点"(endpoint),表示API的具体网址。

在RESTful架构中,每个网址代表一种资源(resource),所以网址中不

转载请注明原文地址: https://www.6miu.com/read-46372.html

最新回复(0)