文档章节

RESTful API

背锅侠
 背锅侠
发布于 2015/08/27 14:33
字数 1293
阅读 111
收藏 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(技术副总裁)
私信 提问
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
1K
2
RESTful API 编写指南

本文首载于 Gevin的博客 基于一些不错的RESTful开发组件,可以快速的开发出不错的RESTful API,但如果不了解开发规范的、健壮的RESTful API的基本面,即便优秀的RESTful开发组件摆在面前,也...

Gevin
2016/06/06
0
0
Restful 风格 API 构建--flask.scalable_rest

使用Python Flask/Flask-Restful快速构建可用可靠的对外HTTP并符合Restful风格的接口!使用JWT(JSON Web Token)对每个api进行授权访问及保护为项目中每个api提供metrics的实时统计,让你随...

搜呗
2015/09/18
1K
0
Flask-RESTful构建小型REST服务

Flask-RESTful构建小型REST服务 2015年6月18日 by debugo · Leave a comment REST是web services和APIs的标准架构,很多APP的架构基本上是使用RESTful的形式了。诸如docker daemon等服务都是...

openthings
2016/04/19
233
0

没有更多内容

加载失败,请刷新页面

加载更多

PHP生成CSV之内部换行

当我们使用PHP将采集到的文件内容保存到csv文件时,往往需要将采集内容进行二次过滤处理才能得到需要的内容。比如网页中的换行符,空格符等等。 对于空格等处理起来都比较简单,这里我们单独...

豆花饭烧土豆
47分钟前
1
0
使用 mjml 生成 thymeleaf 邮件框架模板

发邮件算是系统开发的一个基本需求了,不过搞邮件模板实在是件恶心事,估计搞过的同仁都有体会。 得支持多种客户端 支持响应式 疼彻心扉的 outlook 多数客户端只支持 inline 形式的 css 布局...

郁也风
51分钟前
4
0
让哲学照亮我们的人生——读《医务工作者需要学点哲学》有感2600字

让哲学照亮我们的人生——读《医务工作者需要学点哲学》有感2600字: 作者:孙冬梅;以前读韩国前总统朴槿惠的著作《绝望锻炼了我》时,里面有一句话令我印象深刻,她说“在我最困难的时期,...

原创小博客
今天
3
0
JAVA-四元数类

public class Quaternion { private final double x0, x1, x2, x3; // 四元数构造函数 public Quaternion(double x0, double x1, double x2, double x3) { this.x0 = ......

Pulsar-V
今天
17
0
Xshell利用Xftp传输文件,使用pure-ftpd搭建ftp服务

Xftp传输文件 如果已经通过Xshell登录到服务器,此时可以使用快捷键ctrl+alt+f 打开Xftp并展示Xshell当前的目录,之后直接拖拽传输文件即可。 pure-ftpd搭建ftp服务 pure-ftpd要比vsftp简单,...

野雪球
今天
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部