上传者: 42128676
|
上传时间: 2021-11-25 14:41:56
|
文件大小: 210KB
|
文件类型: -
api接口规范
一报文格式
content-type: application/json
二协议
如果有可能建议尽量用https。
三URL路径命名
1.域名
方式一: api.example.cn (推荐)
方式二: example.cn/api/
2.版本控制
方式一:api.example.cn/v{n}/(推荐)
方式二: 放入http头中
3.api路径规则
路径又称"终点"(endpoint),表示API的具体网址。
在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词。一般来说,数据库中的表都是同种记录的"集合"(collection),所以API中的名词也应该使用复数。
举例来说,有一个API提供动物园(zoo)的信息,还包括各种动物和雇员的信息,则它的路径应该设计成下面这样。
api.example.com/v1/produc