`

RESTful API 设计指南

 
阅读更多

转:http://www.ruanyifeng.com/blog/2014/05/restful_api.html

 

网络应用程序,分为前端和后端两个部分。当前的发展趋势,就是前端设备层出不穷(手机、平板、桌面电脑、其他专用设备......)。

 

因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信。这导致API构架的流行,甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。我以前写过一篇《理解RESTful架构》,探讨如何理解这个概念。

 

今天,我将介绍RESTful API的设计细节,探讨如何设计一套合理、好用的API。我的主要参考了两篇文章(12)。

 

一、协议

 

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

 

二、域名

 

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

 


https://api.example.com

 

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

 


https://example.org/api/

 

三、版本(Versioning)

 

应该将API的版本号放入URL。

 


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

 

另一种做法是,将版本号放在HTTP头信息中,但不如放入URL方便和直观。Github采用这种做法。

 

四、路径(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:指定返回记录的开始位置。
  • ?page=2&per_page=100:指定第几页,以及每页的记录数。
  • ?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]:用户新建或修改数据成功。
  • 202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)
  • 204 NO CONTENT - [DELETE]:用户删除数据成功。
  • 400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。
  • 401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。
  • 403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。
  • 404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。
  • 406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。
  • 410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。
  • 422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。
  • 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。

 

(完)

 

在参考了github的AIP后,对于搜索可以这样,你要搜索什么,如users, animals等,你可以在对应的后面加上一个搜索参数q={query},最后的组合是:
/users?q={query}这样的资源路径。

 

基于JSON的优点,网络服务设计就是应该使用JSON而非陈旧的XML作为返回的数据格式~
这点没错,是时候抛弃XML了~

 

 

过滤信息(Filtering)
有时我们会有比较复杂的过滤比如 : >= , between , || , (color=red && size=s)
这些要怎样用uri来表示呢?

 

将版本号加入到URL中更方便直观,将版本号放在HTTP头信息中更简洁纯粹,个人推荐后者。

 

 

分享到:
评论

相关推荐

    restful API

    ### RESTful API 设计指南 随着信息技术的飞速发展,前端设备种类繁多,从前的单一桌面电脑到如今的智能手机、平板电脑以及其他专用设备等,这些变化促使了前后端分离的趋势更加明显。为了确保不同前端设备能高效地...

    restful api guidelines

    RESTful API设计指南 REST(Representational State Transfer)是一种架构风格,用于构建Web服务,尤其在现代互联网应用程序中被广泛采用。它强调了简洁、可读性、无状态和缓存等原则,使得API(Application ...

    Python语言开发RESTful API指南

    在当今信息技术飞速发展的时代,RESTful ...掌握这些知识点对于设计和实现一个健壮、安全且易于使用的RESTful API至关重要。此外,通过实践经验和持续学习,开发者可以不断提升在Python环境下开发RESTful API的能力。

    C#中的RESTful API设计:最佳实践与实现指南

    在当今的软件开发领域,RESTful API设计已成为构建可扩展、易于维护的Web服务的关键。C#作为一种强大的编程语言,结合ASP.NET Core框架,为设计和实现RESTful API提供了强大的支持。本文将探讨C#中RESTful API设计的...

    基于 RESTful 架构的API设计原则和规范.docx

    * API 设计:Swagger 提供了一个完善的 API 设计指南,以便于设计者设计可维护性、可扩展性和可重用性的 API。 * API 文档化:Swagger 提供了一个完善的文档化解决方案,以便于生成 API 文档和 API 试验环境。 * ...

    RESTful-API-design-OCTO-Quick-Reference-Card-2.2

    此文档旨在为API设计者与开发者提供一个清晰、简洁且易于理解的RESTful API设计指南。REST(Representational State Transfer)是一种用于构建网络应用程序的软件架构风格。其核心原则是将网络应用视为资源集合,并...

    iMaster NCE-Campus V300R019C10SPC207 RESTful API开发指南

    在"iMaster NCE-Campus V300R019C10SPC207 RESTful API开发指南"中,您将深入了解到如何利用这些API来管理和配置企业网络。此指南可能涵盖了以下关键知识点: 1. **RESTful API基础**:介绍RESTful API的基本原理和...

    Python技术的Web框架与RESTful API开发指南.docx

    Python技术在Web开发领域的应用极为广泛,通过选择合适的Web框架和RESTful API设计模式,开发者可以高效地构建出灵活、高效的应用程序。无论是对于初学者还是经验丰富的开发者来说,理解和掌握Python Web框架的基本...

    构建高效RESTful API:Golang最佳实践指南

    通过本文的指南,开发者可以构建高效、安全、可扩展的RESTful API,满足现代Web应用的需求。 本文详细介绍了使用Golang开发RESTful API的最佳实践,包括设计原则、编码实践、安全性、性能优化、监控和测试等方面。...

    iMaster NCE-Fabric V100R021C10 RESTful API开发指南(chm)

    RESTful API设计遵循一些核心原则,包括资源导向、无状态、缓存以及统一接口。在iMaster NCE-Fabric中,这些API可能用于配置网络设备、监控网络状态、自动化工作流以及实现智能网络策略。RESTful API通常通过...

    Python-带RESTfulAPI的自托管文档转换服务

    总的来说,这个项目涉及的知识点包括Python编程、RESTful API设计、HTTP协议、文档处理库(如PyPDF2、python-docx等)、Web框架(如Flask或Django)、数据序列化、测试以及项目管理和文档编写。通过学习和实践此类...

    RESTful架构实战.docx

    2. RESTful API 设计指南 3. HTTP/1.1 规范 总结 ---- RESTful 架构是一种世界观,将信息提升为架构中的公共资源。它提供了高性能、可伸缩、通用性、简单性、可修改性和可扩展等特性。本文解释了 RESTful 架构的...

    RESTful.rar

    在压缩包中的"REST"文件可能就是详细的RESTful API设计指南,包括如何定义资源、使用HTTP方法、设计URI、处理状态码和错误、以及实现安全和版本控制等方面的具体实践和示例。通过学习这些内容,开发者可以更好地理解...

    Hands-On RESTful API Design Patterns and Best Practices

    《实战RESTful API设计模式与最佳实践》一书不仅为开发者提供了一套完整的RESTful API构建指南,还深入探讨了如何利用Java语言的优势来优化API性能。通过学习本书,读者不仅可以掌握RESTful API的基本概念,还能学会...

    我的资源 ,一个上课用到的资源文档,自己我用自己的语言整理的

    RESTful API 设计指南 在本文档中,我们将探讨 RESTful API 的设计原则和实现方法。RESTful API 是一种基于资源的架构风格,通过定义资源、方法和状态码来实现客户端和服务器端之间的交互。 资源 在 RESTful API ...

    NewASP - Restful Api Asp框架

    RESTful API设计模式因其简洁、可扩展性以及资源导向的特性,被广泛应用。本文将详细介绍一个名为“NewASP”的框架,它是一个基于经典ASP(Active Server Pages)VBScript实现的RESTful API框架。 ### 1. ASP框架...

    RESTful Web API Design with Node.JS - Second Edition

    《RESTful Web API设计与实现 第二版》是一本专注于使用Node.js实现RESTful Web API的实用指南。本书的作者是Valentin Bojinov,他是软件开发领域的专家,尤其擅长Java、SOAP以及RESTful Web服务。在本书中,Bojinov...

    liuxiang#blog.hexo#后端文集1

    categories: 后端兄弟- 前端文集RESTful API 规范 v1.0-imweb社区RESTful API 设计指南-阮一峰RESTful API

    restful-api-guidelines:Zalando创建的RESTful API和事件的准则指南的模型集

    RESTful API设计是一种广泛采用的方法,用于构建网络服务接口,以提供高效、可扩展和易于理解的API。Zalando是一家知名的德国电子商务公司,它发布了这个名为"restful-api-guidelines"的准则,旨在帮助开发者遵循...

    springboot +swagger2 restful api

    SpringBoot结合Swagger2创建RESTful API的指南 在现代Web开发中,RESTful API已经成为服务端与客户端交互的标准模式。SpringBoot作为一个轻量级的Java框架,极大地简化了微服务的构建过程。Swagger2则是用于设计、...

Global site tag (gtag.js) - Google Analytics