协议

https

域名

尽量部署在专有域名
https://api.example.com
如果api简单且不需要扩展,可以放在主域名之下
https://example.com/api/

版本

应该将API版本号放入URL
https://api.example.com/v1/
或者将版本号放在HTTP头信息中,但是不够方便直观

路径

url由名词组成,尽量使用复数

HTTP Method

增 POST
查 GET
改 PUT (有幂等性)
改 PATCH (部分修改,无幂等性)
删 DELETE

Hypermedia API(不必须)

在返回值中提供其他API的相关信息