RESTful 接口设计规范 笔记

协议: API与用户的通信协议,http,https协议
域名: eg: http://example.com
版本: 如果接口有版本的迭代的话,可以在域名后面拼接版本标识,eg:http://example.com/v1
路径 又称终点 endpoint, 表示api的具体网址
在restful架构中,每个网址代表一种资源,所以网址中不能有动词,只使用名词且往往与数据库中的表格名对应。一般数据库中的表都是同种记录的集合,所以api中的名词也应该使用复数。

http动词,即接口的请求方法,eg: get,post,put(完整更新),patch(部分更新),DELETE, head(获取资源的元数据),options(获取信息,关于资源的那些属性是客户端可以改变的)。

过滤信息

状态码
客户端的每一次请求,服务器都必须给出回应,回应包括http状态码和数据两部分。


返回结果


错误处理


身份认证

跨域处理
可以在服务端设置cors允许客户端跨域资源请求,或客户端设置代理

posted @ 2024-10-12 17:20  JocelynFung  阅读(7)  评论(0编辑  收藏  举报
Live2D 看板娘 / Demo