网络应用程序,分为前端和后端两个部分。当前的发展趋势,就是前端设备层出不穷(手机、平板、桌面电脑、其他专用设备......)。
因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信。这导致API构架的流行,甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。我以前写过一篇《理解RESTful架构》,探讨如何理解这个概念。
今天,我将介绍RESTful API的设计细节,探讨如何设计一套合理、好用的API。我的主要参考资料是这篇《Principles of good RESTful API Design》。
一、协议
API与用户的通信协议,总是使用HTTPs协议。
二、域名
应该尽量将API部署在专用域名之下。
https://api.example.com
如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下。
https://example.org/api/
三、版本(Versioning)
应该将API的版本号放入URL。
https://api.example.com/v1/
另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便和直观。
四、路径(Endpoint)
路径又称"终点"(endpoint),表示API的具体网址。
在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"集合"(collection),所以API中的名词也应该使用复数。
举例来说,有一个API提供动物园(zoo)的信息,还包括各种动物和雇员的信息,则它的路径应该设计成下面这样。
- https://api.example.com/v1/zoos
- https://api.example.com/v1/animals
- https://api.example.com/v1/employees
五、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 - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。
状态码的完全列表参见这里。
八、错误处理(Error handling)
如果状态码是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", // ... }
从上面可以看到,如果想获取当前用户的信息,应该去访问api.github.com/user,然后就得到了下面结果。
{ "message": "Requires authentication", "documentation_url": "https://developer.github.com/v3" }
上面代码表示,服务器给出了提示信息,以及文档的网址。
十一、其他
(1)API的身份认证应该使用OAuth 2.0框架。
(2)服务器返回的数据格式,应该尽量使用JSON,避免使用XML。
(完)
相关推荐
categories: 后端兄弟- 前端文集RESTful API 规范 v1.0-imweb社区RESTful API 设计指南-阮一峰RESTful API
python找工作各个问题笔记 一、mysql部分 二、django部分 三、Python部分 四、RESTful API设计指南 五、git 六、项目部分
Blog充当日常笔记或者个人博客吧翻译与教程[手写]常用在线站点实践与操作[java]使用Spring实现读写分离( MySQL实现主从复制)RESTful API 设计指南RESTful 良好的API设计风格跟着 Github 学习 Restful HTTP API ...
web-learning learning knowledge of web 学习网站 JS 学习资料 JavaScript标准参考教程 深入理解JavaScript系列 JavaScript秘密花园 ECMAScript 6 入门 ...RESTful API 设计指南 https://zhuanlan.z
API设计技巧和趋势评估的工作指南。 :books: 最初发布在我的中型博客上。 :link: :clapping_hands: 随时在这里阅读,如果喜欢,可以鼓掌/评论。 我们都是手Craft.io的徒弟,没人能成为大师。 我想汇总一些我...
04 ORM查询API 05 模糊查询之万能的双下换线 第52章 01 上节知识回顾 02 ORM多表操作之一对多增加记录 03 ORM多表操作之一对多查询之对象查询 04 ORM多表操作之一对多查询之双下划线查询 05 ORM多表操作之多对多...
保持Restful API Suave中宁静的API的基本实现。 遵循本指南: : 包含一个SqlLite数据库。 创建脚本: 我将其设计为使用和存储Webhook有效负载的简单服务器。 有效负载示例: { "TotalObjects":3, "BatchId": "158b5a...
使用Spring Boot框架设计一个简单的RESTful API。 要求 mysql连接器 Spring Tool Suite 4: : MySQL安装指南: : XAMPP安装教程: : R2HrwSQ6EPM list PLHz_AreHm4dkBs-795Dsgvau_ekxg8g1r index ab_channel ...
《RESTful Web APIs》是针对RESTful API的实用指南,通过展示各种用来创建高可用应用的强大工具,讲解REST的深层原理,以及介绍基于超媒体API的策略,使读者得以在将上述内容融会贯通后,设计出让客户高度满意的...
REST-API-设计指南:NBB的REST-ish API设计指南
军用软件接口设计规范,有详细的接口设计文档模板
为了在遵循 Microsoft REST API 指南的平台上为开发人员提供尽可能流畅的体验,REST API 应遵循一致的设计指南,以使其使用简单直观。 行为准则 该项目采用了微软开源行为准则。 有关更多信息,请参阅行为准则...
本书涵盖以下激动人心的功能: 向您介绍RESTful软件架构风格和REST API设计原则利用JSR 353 API,JSR 374 API,JSR 367 API和Jackson API进行JSON处理利用JAX-RS 2.1 API构建可移植的RESTful Web API 使用Jersey和...
http-api-design-ZH_CN:HTTP API设计指南(http-api-design-ZH_CN),翻译自https:github.cominteragenthttp-api-design
为了提供尽可能流畅的体验Microsoft REST API准则Microsoft REST API准则是Microsoft内部公司范围内的REST API设计准则。 Microsoft的团队通常在设置API设计策略时参考此文档。 他们可以另外创建针对其团队的文档,...
这些库仅设计为RESTful API的包装。 它们使使用API更加容易,但是只会返回API的响应(即JSON有效负载)。 使用这些库时,您务必确保阅读API文档和LearningStudio的背景信息。 这里是一些重要的起点: 按键 对于...
API 的 RESTful 后端。 入门 这些说明将为您提供一份项目副本,并在您的本地机器上运行,用于开发和测试目的。 有关如何在实时系统上部署项目的说明,请参阅部署。 先决条件 为了运行这个应用程序,你需要在你的开发...
swaggerize-express是一种设计驱动的方法,用于使用和构建RESTful api。 swaggerize-express提供以下功能: API模式验证。 基于Swagger文档的路线。 API文档路线。 输入验证。 也可以看看: 为什么要“设计...
设计适用于生产的,可测试的,灵活的RESTful API,用于Web应用程序和微服务 这本书是关于什么的? 带有ASP.NET Core的RESTful Web服务是一个动手指南,它将使您熟悉ASP.NET Core生态系统,并帮助您构建具有所有...
为API设计人员提供早期反馈 确保API的外观相同 支持 提供最佳做法和建议 它的标准配置将检查你的API对中定义的规则,但任何人都可以使用它出的现成。 Zally易于使用的在后台使用服务器,以便您可以当场检查API。 它...