其他潜在的可发现的URI和Microformat 5. 总结 1. 概览 本文将重点介绍REST API的可发现性、HATEOAS及由测试驱动的实际场景。 2....为什么要让API是可发现的 API的可发现性是一个没有得到足够重视的主题，因此很少有API能得到正确的理解。如果能很好的落地，它不仅能使API既RESTful又实用，而且也会很雅致。...在本节中，我们将使用Junit、 rest-assured和Hamcrest来测试API接口的发现性特征。由于以前已经保护了REST服务，所以每个测试首先需要在使用API之前进行身份认证 。...非标准链接关系的使用开启了关于RESTful web服务中微格式和更丰富语义的讨论。 4....下一步，所有状态更改都由客户端使用REST API在表述中提供的可用的和可发现的转换来驱动（因此具有表述性状态转换）。
这导致API构架的流行，甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。...我以前写过一篇《理解RESTful架构》，探讨如何理解这个概念。 今天，我将介绍RESTful API的设计细节，探讨如何设计一套合理、好用的API。我的主要参考了两篇文章（1，2）。...举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。...animal_type_id=1：指定筛选条件 参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoo/ID/animals 与 GET /animals?...Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计，访问api.github.com会得到一个所有可用API的网址列表。
RESTful 是一种软件架构风格，其面向资源。基于 HTTP 协议实现。 设计概念和准则 所有事物都可以被抽象为资源。 每一个资源都有唯一的资源标识，对资源的操作不会改变这些标识。...请求方法 get 获取 post 附加新的资源 (新建) head 请求获取由 REQUEST-URI 所标识的资源的响应信息报头 put 请求服务器存储一个资源，并用 REQUEST-URI...但拒绝提供服务 404 Not Found 500 Internal Server Error 服务器不可预期的错误 503 Server Unavailable 服务器当前不能处理客户端的请求 设计要素...offset=10 状态码 错误处理 { "error":"错误信息" } 返回结果 More Information http://www.ruanyifeng.com/blog/2011/09/restful.html...http://www.ruanyifeng.com/blog/2014/05/restful_api.html https://www.zhihu.com/question/28557115
关于RESTful API 相关资料： RESTFUL是一种网络应用程序的设计风格和开发方式，基于HTTP，可以使用XML格式定义或JSON格式定义。...RESTFUL适用于移动互联网厂商作为业务使能接口的场景，实现第三方OTT调用移动网络资源的功能，动作类型为新增、变更、删除所调用资源。...通常，使用RESTful风格的API，响应给客户端的数据是XML或JSON格式的，也就是“响应正文”，是使用了前后端分离的开发方式。...在RESTful架构中，浏览器使用POST，DELETE，PUT和GET四种请求方式分别对指定的URL资源进行增删改查操作。...因此，RESTful是通过URI实现对资源的管理及访问，具有扩展性强、结构清晰的特点。
https://api.example.com 如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。...在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。...举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。...GET（SELECT）：从服务器取出资源（一项或多项）。 POST（CREATE）：在服务器新建一个资源。 PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。...animaltype_id=1：指定筛选条件 七、状态码（Status Codes） 服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。
订阅本站 近期学习了Go语言，跟着七米在学习，学习过程中了解到了 API 的一个设计规范，也就是本文要讲的 Restful API 设计模式，现在互联网处在前后端分离的阶段，API 的书写及规范化是非常重要的...，针对于 API 中 Restful API 中设计比较规范的是 Github API，可以直接访问他们的 https://api.github.com 直接查看 Github 针对与公共接口的链接及使用方法...此篇文章也是针对于这几天学习 Restful API 做了一个笔记或小结，若有不足之处还望批评指正，谢谢。...304 Not Modified 请求的资源和之前的版本一样，没有发生改变。...参考资料 RESTful API 设计指南 – 阮一峰 跟着 Github 学习 Restful HTTP API 设计 REST API Tutorial Representational State
资源是任何RESTful API中的基本概念。资源是对象，包括类型、关联的数据、资源间的关系以及资源上的操作集合。...下图描述了RESTful API的关键概念： 我们把描述资源的类型、行为和关系的信息称为API的资源模型。RESTful中的资源模型可以视为到应用数据模型的映射。 资源数据 资源关联数据。...API的资源模型还包括关联数据的丰富性。比如，它定义了哪些可用的数据类型和行为。 就我个人经验，我坚信JSON这种数据模型完美满足API的丰富性要求，它是RESTful资源的理想数据模型。...REST元数据 除了暴露应用数据，资源中还有RESTful API相关特殊的数据。这些信息包括URLs和relationships。...我认为所有的资源应该共享那些相同的、基本的接口，这些基本接口是符合RESTful设计原则，内容类型表示为“application/x-resource”。
亚马逊是如何有效地使用 api 进行通信的最佳例子。 在这篇文章中，我将讨论如何更好地设计 RESTful api 以避免常见错误。...---- RESTful api 的设计原则 现在，让我们来了解在设计 RESTful api 时应该遵循的原则。 保持精简 我们需要确保 API 的基本 URL 是简单的。...使用正确的 HTTP 方法 RESTful API 有各种方法来指示我们将使用此 API 执行的操作类型。 GET — 获取资源，请求指定的页面信息，并返回实体主体。...POST — 创建资源，向指定资源提交数据进行处理请求（例如提交表单或者上传文件）。数据被包含在请求体中。POST 请求可能会导致新的资源的建立和/或已有资源的修改。...使用分页 当您公开可能返回大量数据的 API 时，必须使用分页，如果没有进行适当的负载平衡，消费者可能最终会关闭服务。我们需要始终记住，API 设计应该是完整的证明和傻瓜证明。
资源和路由设计在 Flask-RESTful 中，每个资源都是一个独立的类，并继承自 Flask-RESTful 的 Resource 类。...资源类中定义了可以处理 HTTP 请求的方法，例如 GET、POST、PUT 和 DELETE 等。...路由和资源之间的映射关系通过 api.add_resource() 方法进行定义，其中第一个参数是资源类，第二个参数是 URL 路径。...以下是示例代码：from flask_restful import Apiapp = Flask(__name__)api = Api(app)# 将 User 资源类绑定到 /users/资源类的设计和路由的绑定，客户端可以通过 GET 请求访问 /users/int:user_id 路径来查询用户对象了。
背景 目前互联网上充斥着大量的关于RESTful API（为了方便，以后API和RESTful API 一个意思）如何设计的文章，然而却没有一个”万能“的设计标准：如何鉴权？API格式如何？...API设计的基本要求 网上的很多关于API设计的观点都十分”学院派“，它们也许更有理论基础，但是有时却和现实世界脱轨（因此我是自由派）。...使用RESTful URLs 和action. 虽然前面我说没有一个万能的API设计标准。但确实有一个被普遍承认和遵守：RESTfu设计原则。...显然从API用户的角度来看，”资源“应该是个名词。即使你的内部数据模型和资源已经有了很好的对应，API设计的时候你仍然不需要把它们一对一的都暴露出来。这里的关键是隐藏内部资源，暴露必需的外部资源。...为此REST制定了HATEOAS来描述了和endpoint进行交互的时候，行为应该在资源的metadata返回值里面进行定义。
在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。...举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。...animal_type_id=1：指定筛选条件 参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoo/ID/animals 与 GET /animals?...：返回一个空文档 十、Hypermedia API RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。...Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计，访问api.github.com会得到一个所有可用API的网址列表。
概念 本质：一种软件架构风格 核心：面向资源设计的API 解决问题： 降低开发的复杂性 提高系统的可伸缩性 例如：设计一套API，为多个终端服务。...而RESTful API 在请求方法、资源、地址都进行了规范，其最大限度的利用了HTTP最初的应用协议的设计理念。...使用RESTful 设计RESTful API 资源路径（URI）：RESTful的核心是面向资源，如何规划资源路径很重要 HTTP动词(请求方式)：如get,post,delete,put...例如：有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，那么它的资源路径应设计成如下样子。 https://api.example.com/v1/zoos //动物园资源。...（参考：http://graphql.cn/ ） 参考 慕课教程 Restful API 的设计规范 理解RESTful架构 RESTful架构基础
参考github的api，总结一份实践经验，方便以后设计api查阅。 ? 使用https 考虑api的安全性，建议使用https访问。 证书可使用let’s encrypt的免费证书。...api访问地址与版本 访问地址使用统一的api前缀，或者使用二级域名，版本号建议显式的放在url中。...url设计 操作针对资源进行，使用url来代表资源，使用http请求方法来指明进行的操作。...例如： // 查询用户列表 GET: https://www.iian.xyz/api/v1/users // 删除用户 DELETE: https://www.iian.xyz/api/v1/users.../1 // 添加用户 POST: https://www.iian.xyz/api/v1/users // 修改用户信息 PUT: https://www.iian.xyz/api/v1/users/1
作者：马一特 cnblogs.com/mayite/p/9798913.html RESTful 是目前最流行的 API 设计规范，用于 Web 数据接口的设计。...本文总结 RESTful 的设计细节，介绍如何设计出易于理解和使用的 API。...---- 一、URL设计 动词+宾语 RESTful的核心思想就是，客户端发出的数据+操作指令都是“动词+宾语”的结构，比如GET /articles这个命令，GET是动词，/articles是宾语，动词通常就有...这样的话，用户只要记住一个 URL，就可以发现其他的 URL。这种方法叫做 HATEOAS。 举例来说，GitHub 的 API 都在 api.github.com 这个域名。...对于用户来说，不需要记住 URL 设计，只要从 api.github.com 一步步查找就可以了。 HATEOAS 的格式没有统一规定，上面例子中，GitHub 将它们与其他属性放在一起。
原文出处：RESTful API Design. Best Practices in a Nutshell. 原文：RESTful API Design....作者：Philipp Hauer 项目资源的URL应该如何设计？用名词复数还是用名词单数？一个资源需要多少个URL？用哪种HTTP方法来创建一个新的资源？可选参数应该放在哪里？...哪些不涉及资源操作的URL呢？实现分页和版本控制的最好方法是什么？因为有太多的疑问，设计RESTful API变得很棘手。...在这篇文章中，我们来看一下RESTful API设计，并给出一个最佳实践方案。...如果您有不兼容和破坏性的更改，版本号可以让你更容易的发布API。发布新API时，只需增加版本号中的数字。这样的话，客户端可以自如的迁移到新API，不会因调用完全不同的新API而陷入困境。
Web API 近几年变得越来越火，而简洁的 API 设计在多后端系统交互应用中也变得尤为重要。通常，会使用 RESTful API 来作为我们的 Web API 。...本文介绍了几种简洁 RESTful API 设计的最佳实践。...对于不使用 HATEOAS 的 REST 服务，客户端和服务器的实现之间是紧密耦合的。客户端需要根据服务器提供的相关文档来了解所暴露的资源和对应的操作。...当服务器发生了变化时，如修改了资源的 URI，客户端也需要进行相应的修改。而使用 HATEOAS 的 REST 服务中，客户端可以通过服务器提供的资源的表达来智能地发现可以执行的操作。...当服务器发生了变化时，客户端并不需要做出修改，因为资源的 URI 和其他信息都是动态发现的。
这导致API构架的流行，甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。...我以前写过一篇《理解RESTful架构》，探讨如何理解这个概念。 今天，我将介绍RESTful API的设计细节，探讨如何设计一套合理、好用的API。我的主要参考了两篇文章（1，2）。 ?...举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。...animal_type_id=1：指定筛选条件 参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoo/ID/animals 与 GET /animals?...Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计，访问api.github.com会得到一个所有可用API的网址列表。
RESTful API设计指南 #1 环境 Python3.7.3 djangorestframework==3.8.2 #2 动词 methods url 说明 GET /zoos 列出所有动物园(列表...410 Gone [GET] 用户请求的资源被永久删除，且不会再得到的。 422 Unprocesable entity [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。...#4 curl 命令参考 curl -i -H "Content-Type: application/json" -X DELETE http://localhost:5632/blog/api/articles
RESTFUL是一种网络应用程序的设计风格和开发方式，基于HTTP，可以使用XML格式定义或JSON格式定义。...RESTFUL适用于移动互联网厂商作为业务使能接口的场景，实现第三方OTT调用移动网络资源的功能，动作类型为新增、变更、删除所调用资源。...在当前流行的前后端分离架构，人们发现原来这套用于超文本传输的协议是如此适合用于设计基于互联网的api接口，基于http动词以及标准的http status返回信息，能够非常好地描述api的特性，并且可读性非常好...更重要的是，由于http是事实上的互联网通讯标准协议，基于rest设计的api接口，就好像你出国用英语和别人交流，完全不存在沟通障碍。...现在jane想设计一个api接口，实现对这张图片的删除操作，这个api应该怎么设计？
领取专属 10元无门槛券
手把手带您无忧上云
云服务器
ICP备案
云直播
对象存储
实时音视频
