文档章节

RESTful API

背锅侠
 背锅侠
发布于 2015/08/27 14:33
字数 1293
阅读 135
收藏 13

#程序员薪资揭榜#你做程序员几年了?月薪多少?发量还在么?>>>

协议

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

域名

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

https://api.example.com

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

https://example.org/api/

版本

应该将API的版本号放入URI

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

也可以放在HTTP头信息中,但不如仿如URI直观

路径

路径就是API的网址,每一个路径代表一种资源,所以路径只有名词不能有动词。而且所用的名词往往与数据库表名对应。一般而言,数据库中的表是记录的集合,因此API中的名词也应该使用复数。例如:

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

HTTP动词

对于资源的具体操作,由HTTP动词表示
常用的HTTP动词包括一下几个,括号里是对应的SQL命令:

  • GET(SELECT): 从服务器取出资源(一个或多个)

  • POST(CREATE): 在服务器新建一个资源

  • PUT(UPDATE): 在服务器更新资源(客户端提供改变后的完整资源,即更新整一个资源)

  • PATCH(UPDATE): 在服务器更新资源(客户端提供改变的属性,即更新资源的部分属性)

  • DELETE(DELETE): 从服务器删除资源

还有两个不常用的HTTP动词

  • HEAD: 获取资源的元数据

  • OPTIONS: 获取信息,关于资源的哪些属性是客户端可以改变的

下面是若干例子:

  • GET /zoos:列出所有动物园

  • POST /zoos:新建一个动物园

  • GET /zoos/ID:获取某个指定动物园的信息

  • PUT /zoos/ID:更新某个指定动物园的信息(提供该动物园的全部信息)

  • PATCH /zoos/ID:更新某个指定动物园的信息(提供该动物园的部分信息)

  • DELETE /zoos/ID:删除某个动物园

  • GET /zoos/ID/animals:列出某个指定动物园的所有动物

  • DELETE /zoos/ID/animals/ID:删除某个指定动物园的指定动物

过滤信息(Filtering)

如果记录数过多,服务器不可能一次性将所有的信息返回给客户端。API应该提供参数,过滤返回结果。下面一些常见的参数:

  • ?limit=10:指定返回记录的数量

  • ?offset=10:指定返回记录的开始位置

  • ?sortby=name&order=asc:指定返回结果按照哪个属性排序,以及排序顺序

  • ?animal_type_id=1:指定筛选条件

参数的设计允许存在冗余,即允许API路径和URL参数偶尔有重复。比如,GET /zoo/ID/animals 与 GET /animals?zoo_id=ID 的含义是相同的。

状态码(Status Codes)

服务器向用户返回的状态码和提示信息,常见的有以下一些(方括号中是该状态码对应的HTTP动词)

  • 200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)

  • 201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功

  • 204 NO CONTENT - [DELETE]:用户删除数据成功

  • 400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的

  • 404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的

  • 500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功

状态码的完整列表参见这里

错误处理

如果状态码是4XX,就应该向客户端返回出错信息。一般来说,返回的信息中将error作为键名。

{ error: "Invalid API key" }

返回结果

针对不同的操作,服务器想客户端返回的结果应该符合一下规范

  • GET /collection:返回资源对象的列表(数组)

  • GET /collection/resource:返回单个资源对象

  • POST /collection:返回新生成的资源对象

  • PUT /collection/resource:返回更新后完整的资源对象

  • PATCH /collection/resource:返回更新后完整的资源对象

  • DELETE /collection/resource:返回一个空文档

Hypermedia API

RESTful API最好做到Hypermedia,即返回结果中提供链接,指向其他API方法,是的用户不查文档,也知道该怎么做。比如,当用户向api.example.com的根目录发出请求,会得到这样一个文档:

{"link": {
"rel": "collection https://www.example.com/zoos",
"href": "https://api.example.com/zoos",
"title": "List of zoos",
"type": "application/vnd.yourformat+json"
}}

上面代码表示,文档中有一个link属性,用户读取这个属性就知道下一步该调用什么API了。rel表示这个API与当前网址的关系(collection关系,并给出该collection的网址),href表示API的路径,title表示API的标题,type表示返回类型

Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计,访问api.github.com会得到一个所有可用API的网址列表

{
"current_user_url": "https://api.github.com/user",
"authorizations_url": "https://api.github.com/authorizations",
// ...
}

其他

  1. API的身份认证应该使用OAuth2.0框架

  2. 服务器返回的数据格式,应该尽量适应JSON,避免使用XML


本文转载自:http://www.jianshu.com/p/00631797a60d

背锅侠

背锅侠

粉丝 10
博文 18
码字总数 13050
作品 0
东城
CTO(技术副总裁)
私信 提问
加载中

评论(0)

RESTful - 收藏集 - 掘金

远程接口设计经验分享 - 后端 - 掘金 写在前边 分布式架构是互联网应用的基础架构,很多新人入职以来就开始负责编写和调用阿里的各种远程接口。但如同结婚一般,用对一个正确的接口就如同嫁一...

掘金官方
2017/05/26
0
0
RESTful API 设计参考文献--restful-api-design-references

restful-api-design-references是RESTful API 设计参考文献列表,可帮助你更加彻底的了解REST风格的接口设计。 RESTful 介绍及设计思路 Principles of good RESTful API Design(译:好 REST...

匿名
2016/09/12
2.3K
2
flask restful-api实现及基于flask-httpauth实现基础权限管控(二)

本系列教程分为四个阶段 1.flask restful web service 2.flask restful api 3.flask httpauth实现权限管控 4.uwsgi管理flask应用     在上一篇文章中,介绍学习了flask实现restful web ser...

邱野
05/14
0
0
使用ASP.NET Core 3.x 构建 RESTful API - 3.4 内容协商

现在,当谈论起 RESTful Web API 的时候,人们总会想到 JSON。但是实际上,JSON 和 RESTful API 没有半毛钱关系,只不过 JSON 恰好是RESTful API 结果的表述格式。也就是说 RESTful API 还可...

solenovex
2019/12/16
0
0
容器化单页面应用中RESTful API的访问

最近在工作中,需要让运行在容器中的单页面应用程序能够访问外部的RESTful API。这个需求看起来并不困难,不过实现起来还是有些曲折的。在此,我就将这部分内容总结一下。 在入正题之前,有个...

dax.net
2019/06/22
0
0

没有更多内容

加载失败,请刷新页面

加载更多

python设置搜索路径,以及外层文件调用时路径变动问题

通过sys.path设置路径 import syssys.path.append("待加入的搜索路径") 修改python环境变量 编辑 ~/.profile 文件:export PYTHONPATH= $PYTHONPATH:搜索路径临时修改方法:直接在命令...

hc321
刚刚
0
0
一个开源的跨平台音乐播放与音乐下载器

跨平台的音乐播放器 目前国内的linux平台上的音乐播放器不多,除了网易云比较多人使用的。 当然Listen1也是一个不错的选择,真正的跨平台,包括Android/Mac/Win/Linux以及Chrome插件,目前尚...

氷泠
6分钟前
8
0
联盟之畔,算力之颠——超算产业峰会,邀你共享

2020年5月30日,在成都首座万豪酒店,一场关于【算力之巅 超算产业峰会】正在如火如荼进行着,Tokenlnsight联合多位算力界代表人物参与此次峰会,一起探讨挖矿与财富机遇的话题,星际联盟也很...

IPFS星际联盟
10分钟前
5
0
Oracle学习(五) --- 视图、序列、同义词、索引

1、视图 1.1、什么是视图 视图就是一个虚拟表,实体表的映射。 什么时候使用视图 在开发中,有一些表结构是不希望过多的人去接触,就把实体表映射为一个视图。(表结构简化) 在项目过程中,程...

庭前云落
20分钟前
10
0
设置JavaScript函数的默认参数值 - Set a default parameter value for a JavaScript function

问题: I would like a JavaScript function to have optional arguments which I set a default on, which get used if the value isn't defined (and ignored if the value is passed). 我......

javail
23分钟前
15
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部