业务逻辑和restful API设计 - 腾讯云开发者社区 - 腾讯云

开发者社区

文档建议反馈控制台

文章/答案/技术大牛

发布

RESTful 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的网址列表。

9111 0

RESTful 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的网址列表。

9864 0

您找到你想要的搜索结果了吗？

是的

没有找到

Restful API 设计指北

订阅本站近期学习了Go语言，跟着七米在学习，学习过程中了解到了 API 的一个设计规范，也就是本文要讲的 Restful API 设计模式，现在互联网处在前后端分离的阶段，API 的书写及规范化是非常重要的...，针对于 API 中 Restful API 中设计比较规范的是 Github API，可以直接访问他们的 https://api.github.com 直接查看 Github 针对与公共接口的链接及使用方法...此篇文章也是针对于这几天学习 Restful API 做了一个笔记或小结，若有不足之处还望批评指正，谢谢。...9、Hypermedia API RESTful API 最好做到 Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。...参考资料 RESTful API 设计指南 – 阮一峰跟着 Github 学习 Restful HTTP API 设计 REST API Tutorial Representational State

9862 0

RESTful API 设计详解

RESTful 是一种软件架构风格，其面向资源。基于 HTTP 协议实现。设计概念和准则所有事物都可以被抽象为资源。每一个资源都有唯一的资源标识，对资源的操作不会改变这些标识。...但拒绝提供服务 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

1.1K4 0

RESTful API设计--指南

亚马逊是如何有效地使用 api 进行通信的最佳例子。在这篇文章中，我将讨论如何更好地设计 RESTful api 以避免常见错误。...毫无例外，所有服务接口都必须从头开始设计，才能外部化。也就是说，团队必须进行规划和设计，以便能够向外部世界的开发人员公开接口。没有例外。任何不这样做的人都会被解雇。...---- RESTful api 的设计原则现在，让我们来了解在设计 RESTful api 时应该遵循的原则。保持精简我们需要确保 API 的基本 URL 是简单的。...使用正确的 HTTP 方法 RESTful API 有各种方法来指示我们将使用此 API 执行的操作类型。 GET — 获取资源，请求指定的页面信息，并返回实体主体。...使用分页当您公开可能返回大量数据的 API 时，必须使用分页，如果没有进行适当的负载平衡，消费者可能最终会关闭服务。我们需要始终记住，API 设计应该是完整的证明和傻瓜证明。

2.1K5 0

RESTful API 设计指南

SOAP（Simple Object Access protocol，简单对象访问协议）以及XML-RPC更加简单明了，无论是对URL的处理还是对Payload的编码，REST都倾向于用更加简单轻量的方法设计和实现...举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。...animal_type_id=1：指定筛选条件参数的设计允许存在冗余，即允许API路径和URL参数偶尔有重复。比如，GET /zoo/ID/animals 与 GET /animals?...RESTful API最好做到Hypermedia，即返回结果中提供链接，连向其他API方法，使得用户不查文档，也知道下一步应该做什么。...Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计，访问api.github.com会得到一个所有可用API的网址列表。

1.1K5 0

RESTful API设计指南

一、协议 API与用户的通信协议，总是使用HTTP/HTTPS协议。二、域名路径应该尽量将API部署在专用域名之下。...https://api.example.com 如果确定API很简单，不会有进一步扩展，可以考虑放在主域名下。...在RESTful架构中，每个网址代表一种资源（resource），所以网址中不能有动词，只能有名词，而且所用的名词往往与数据库的表格名对应。...举例来说，有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，则它的路径应该设计成下面这样。...animaltype_id=1：指定筛选条件七、状态码（Status Codes）服务器向用户返回的状态码和提示信息，常见的有以下一些（方括号中是该状态码对应的HTTP动词）。

6593 0

RESTful 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的网址列表。

1.3K5 0

RESTful API 设计最佳实践

原文出处：RESTful API Design. Best Practices in a Nutshell. 原文：RESTful API Design....实现分页和版本控制的最好方法是什么？因为有太多的疑问，设计RESTful API变得很棘手。在这篇文章中，我们来看一下RESTful API设计，并给出一个最佳实践方案。...不要这么设计： /getAllEmployees /getAllExternalEmployees /createEmployee /updateEmployee 更好的设计： GET /employees...如果您有不兼容和破坏性的更改，版本号可以让你更容易的发布API。发布新API时，只需增加版本号中的数字。这样的话，客户端可以自如的迁移到新API，不会因调用完全不同的新API而陷入困境。...另一个好处是，你的API变得可以自我描述，需要写的文档更少。在分页时，您还可以添加获取下一页或上一页的链接示例。只需提供适当的偏移和限制的链接示例。 GET /employees?

1.8K6 0

restful api设计最佳实践

参考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

8931 0

浅谈RESTful API设计风格

关于RESTful API 相关资料： RESTFUL是一种网络应用程序的设计风格和开发方式，基于HTTP，可以使用XML格式定义或JSON格式定义。...RESTFUL适用于移动互联网厂商作为业务使能接口的场景，实现第三方OTT调用移动网络资源的功能，动作类型为新增、变更、删除所调用资源。...通常，使用RESTful风格的API，响应给客户端的数据是XML或JSON格式的，也就是“响应正文”，是使用了前后端分离的开发方式。...在RESTful架构中，浏览器使用POST，DELETE，PUT和GET四种请求方式分别对指定的URL资源进行增删改查操作。...但是，基于开发人员的使用习惯，甚至某些复杂的业务可能包含增删改查中的多种数据操作，无法准确的定义这到底是哪一种操作，所以，常规做法依然只使用POST和GET这2种请求方式，并不使用PUT和DELETE方式

1K2 0

【RESTful】RESTful API 接口设计规范 | 示例

而RESTful API 在请求方法、资源、地址都进行了规范，其最大限度的利用了HTTP最初的应用协议的设计理念。...使用RESTful 设计RESTful API 资源路径（URI）：RESTful的核心是面向资源，如何规划资源路径很重要 HTTP动词(请求方式)：如get,post,delete,put...例如：有一个API提供动物园（zoo）的信息，还包括各种动物和雇员的信息，那么它的资源路径应设计成如下样子。 https://api.example.com/v1/zoos //动物园资源。...当然，处理RESTful API设计思想，还有最近流行的GraphQL，它是一种API查询语言，其将所见即所得的思想引入，能帮助提升开发的体验与应用的性能。...（参考：http://graphql.cn/ ）参考慕课教程 Restful API 的设计规范理解RESTful架构 RESTful架构基础

3.1K2 0

Restful API设计规范

RESTFUL是一种网络应用程序的设计风格和开发方式，基于HTTP，可以使用XML格式定义或JSON格式定义。...RESTFUL适用于移动互联网厂商作为业务使能接口的场景，实现第三方OTT调用移动网络资源的功能，动作类型为新增、变更、删除所调用资源。...在当前流行的前后端分离架构，人们发现原来这套用于超文本传输的协议是如此适合用于设计基于互联网的api接口，基于http动词以及标准的http status返回信息，能够非常好地描述api的特性，并且可读性非常好...更重要的是，由于http是事实上的互联网通讯标准协议，基于rest设计的api接口，就好像你出国用英语和别人交流，完全不存在沟通障碍。...api接口，实现对这张图片的删除操作，这个api应该怎么设计？

1.7K3 0

RESTful API 设计最佳实践

Web API 近几年变得越来越火，而简洁的 API 设计在多后端系统交互应用中也变得尤为重要。通常，会使用 RESTful API 来作为我们的 Web API 。...本文介绍了几种简洁 RESTful API 设计的最佳实践。...它的重要性在于打破了客户端和服务器之间严格的契约，使得客户端可以更加智能和自适应，而 REST 服务本身的演化和更新也变得更加容易。...SOAP 和 XML-RPC 都属于此类。第二个层次（Level 1）的 Web 服务引入了资源的概念。每个资源有对应的标识符和表达。...在设计 API 处理错误时，应该充分使用 HTTP 状态码，而不是简单的抛出个 “500 – Internal Server Error（内部服务器错误）” 所有的异常都应该有个错误的 payload

8413 0

RESTful API 设计规范

作者：马一特 cnblogs.com/mayite/p/9798913.html RESTful 是目前最流行的 API 设计规范，用于 Web 数据接口的设计。...本文总结 RESTful 的设计细节，介绍如何设计出易于理解和使用的 API。...---- 一、URL设计动词+宾语 RESTful的核心思想就是，客户端发出的数据+操作指令都是“动词+宾语”的结构，比如GET /articles这个命令，GET是动词，/articles是宾语，动词通常就有...: "2130040" } } 3xx 状态码 API 用不到301状态码（永久重定向）和302状态码（暂时重定向，307也是这个含义），因为它们可以由应用级别返回，浏览器会直接跳转，API 级别可以不考虑这两种情况...它与302和307的含义一样，也是"暂时重定向"，区别在于302和307用于GET请求，而303用于POST、PUT和DELETE请求。

1.1K3 0

Django RESTful API设计指南

RESTful API设计指南 #1 环境 Python3.7.3 djangorestframework==3.8.2 #2 动词 methods url 说明 GET /zoos 列出所有动物园(列表...#4 curl 命令参考 curl -i -H "Content-Type: application/json" -X DELETE http://localhost:5632/blog/api/articles

1.3K2 0

RESTful API 设计最佳实践

背景目前互联网上充斥着大量的关于RESTful API（为了方便，以后API和RESTful API 一个意思）如何设计的文章，然而却没有一个”万能“的设计标准：如何鉴权？API格式如何？...你的API是否应该加入版本信息？当你开始写一个app的时候，特别是后端模型部分已经写完的时候，你不得不殚精竭虑的设计和实现自己app的public API部分。...API设计的基本要求网上的很多关于API设计的观点都十分”学院派“，它们也许更有理论基础，但是有时却和现实世界脱轨（因此我是自由派）。...使用RESTful URLs 和action. 虽然前面我说没有一个万能的API设计标准。但确实有一个被普遍承认和遵守：RESTfu设计原则。...排序：和过滤一样，一个好的排序参数应该能够描述排序规则，而不业务相关。

1.9K9 0

RESTful API 设计最佳实践

背景目前互联网上充斥着大量的关于RESTful API（为了方便，以后API和RESTful API 一个意思）如何设计的文章，然而却没有一个”万能“的设计标准：如何鉴权？API格式如何？...API设计的基本要求网上的很多关于API设计的观点都十分”学院派“，它们也许更有理论基础，但是有时却和现实世界脱轨（因此我是自由派）。...API应该具有足够的灵活性来支持上层ui。 API设计权衡上述几个原则。需要强调的是：API的就是程序员的UI，和其他UI一样，你必须仔细考虑它的用户体验！...使用RESTful URLs 和action. 虽然前面我说没有一个万能的API设计标准。但确实有一个被普遍承认和遵守：RESTfu设计原则。...排序：和过滤一样，一个好的排序参数应该能够描述排序规则，而不业务相关。

1.6K4 0

RESTful API 设计最佳实践

实现分页和版本控制的最好方法是什么？因为有太多的疑问，设计RESTful API变得很棘手。在这篇文章中，我们来看一下RESTful API设计，并给出一个最佳实践方案。...不要这么设计： /getAllEmployees /getAllExternalEmployees /createEmployee /updateEmployee 更好的设计： GET /employees...通常，RESTful Web服务将被JavaScript编写的客户端使用。...如果您有不兼容和破坏性的更改，版本号将让你能更容易的发布API。发布新API时，只需在增加版本号中的数字。这样的话，客户端可以自如的迁移到新API，不会因调用完全不同的新API而陷入困境。...另一个好处是，你的API变得可以自我描述，需要写的文档更少。在分页时，您还可以添加获取下一页或上一页的链接示例。只需提供适当的偏移和限制的链接示例。 GET /employees?

1.7K1 0

RESTFUL API 安全设计指南

RESTful web services 概念的核心就是“资源”。资源可以用 URI 来表示。...key=dfkaj134,一般的处理流程如下：一个简单的设计示例如下： client端： ? server端： ?...这样的设计就防止了数据被篡改。通过这种API Key的设计方式加了时间戳防止了部分重放，加了校验，防止了数据被篡改，同时避免了传输用户名和密码，当然了也会有一定的开销。...使用和配置都比较复杂，这里就不涉及了。...rest api接口一般会用到GET,POST,PUT,DELETE,未实现的方法则直接返回方法不允许，对于POST，PUT方法的数据采用json格式，并且在进入逻辑前验证是否json，不合法返回json

1.8K2 0

点击加载更多

相关资讯

热门标签

活动推荐

运营活动

活动名称

广告关闭