后端工程师,如何无脑设计一些shi一样的URI,来恶心移动/前端工程师呢? 希望本文能给大家一些启示。 方法一:搞一些不知所谓的名称。...例如: http://api.exapmle.com/louvre/da-vinci/mona-lisa 画外音:卢浮宫/达芬奇/蒙娜丽莎 方法三:多在URI的末尾添加“/”,让别人以为是目录,还有可能帮他们多搞一次...http://api.canvas.com/shapes/ 而这样没有歧义的api,是万万不行的: http://api.canvas.com/shapes 方法四:多使用“_”而不是“-”提高URI...例如: http://api.example.com/My-Folder/My-Doc 画外音:RFC 3986中规定URI区分大小写。 学会了吗?注意保护好自己!...玩笑归玩笑,好的URI,建议这么弄: (1)RESTful是基本原则,命名要有意义; (2)不要用容易拼错的外语; (3)URI的末尾不要添加“/”; (4)使用“-”而不是“_”,以提高URI的可读性
在了解 REST API URI 设计的规则之前,让我们快速过一下我们将要讨论的一些术语。 URI REST API 使用统一资源标识符(URI)来寻址资源。...REST API 设计人员应该创建 URI,将 REST API 的资源模型传达给潜在的客户端开发人员。在这篇文章中,我将尝试为 REST API URsI 引入一套设计规则。...如果一个关系只能存在于另一个资源中,RESTful 原则可以提供有用的指导。我们来看一下这个例子。某个学生有一些课程。...结论 当你设计 REST API 服务时,你必须注意资源,这些资源由 URI 定义。 你正在构建的服务中的每个资源,都将至少有一个 URI 来标识它。这个 URI 最好是有意义的,并能充分描述资源。...URI 应遵循可预测的层次结构,以增强可理解性,从而提高可用性:可预测的意义在于它们是一致的,层次结构建立在数据具有结构关系的意义上。 RESTful API 是为消费者编写的。
这导致API构架的流行,甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。...我以前写过一篇《理解RESTful架构》,探讨如何理解这个概念。 今天,我将介绍RESTful API的设计细节,探讨如何设计一套合理、好用的API。我的主要参考了两篇文章(1,2)。...在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。...Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计,访问api.github.com会得到一个所有可用API的网址列表。...转自:http://www.ruanyifeng.com/blog/2014/05/restful_api.html
这导致API构架的流行,甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。...我以前写过一篇《理解RESTful架构》,探讨如何理解这个概念。 今天,我将介绍RESTful API的设计细节,探讨如何设计一套合理、好用的API。我的主要参考了两篇文章(1,2)。...在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。...举例来说,有一个API提供动物园(zoo)的信息,还包括各种动物和雇员的信息,则它的路径应该设计成下面这样。...Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计,访问api.github.com会得到一个所有可用API的网址列表。
而RESTful API 在请求方法、资源、地址都进行了规范,其最大限度的利用了HTTP最初的应用协议的设计理念。...使用RESTful 设计RESTful API 资源路径(URI):RESTful的核心是面向资源,如何规划资源路径很重要 HTTP动词(请求方式):如get,post,delete,put...过滤信息:例如获取资源列表时有分页操作/查询操作,这时要合理分配过滤信息,过滤信息设置太多,有可能会违反RESTful API 关于URI方面的限定。...例如,使用users反映用户资源的URI,而不是使用user。 例如:有一个API提供动物园(zoo)的信息,还包括各种动物和雇员的信息,那么它的资源路径应设计成如下样子。...(参考:http://graphql.cn/ ) 参考 慕课教程 Restful API 的设计规范 理解RESTful架构 RESTful架构基础
1 用户权限认证后获取服务端的token,将token存入客户端cookie中。
订阅本站 近期学习了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
RESTful 是一种软件架构风格,其面向资源。基于 HTTP 协议实现。 设计概念和准则 所有事物都可以被抽象为资源。 每一个资源都有唯一的资源标识,对资源的操作不会改变这些标识。...请求方法 get 获取 post 附加新的资源 (新建) head 请求获取由 REQUEST-URI 所标识的资源的响应信息报头 put 请求服务器存储一个资源,并用 REQUEST-URI...但拒绝提供服务 404 Not Found 500 Internal Server Error 服务器不可预期的错误 503 Server Unavailable 服务器当前不能处理客户端的请求 设计要素...资源路径 URI 每个网址代表一种资源,网址中不能有动词,只能是名词,名词应该是复数 HTTP 动词 get、post, etc 过滤信息 url?...http://www.ruanyifeng.com/blog/2014/05/restful_api.html https://www.zhihu.com/question/28557115
在这篇文章中,我将讨论如何更好地设计 RESTful api 以避免常见错误。...毫无例外,所有服务接口都必须从头开始设计,才能外部化。也就是说,团队必须进行规划和设计,以便能够向外部世界的开发人员公开接口。没有例外。 任何不这样做的人都会被解雇。...---- RESTful api 的设计原则 现在,让我们来了解在设计 RESTful api 时应该遵循的原则。 保持精简 我们需要确保 API 的基本 URL 是简单的。...使用正确的 HTTP 方法 RESTful API 有各种方法来指示我们将使用此 API 执行的操作类型。 GET — 获取资源,请求指定的页面信息,并返回实体主体。...因此,尽最大努力做好设计,剩下的只是实现。 ---- 感谢您的阅读 如果你遇到了一些更好的设计 api 的方法,请随时在评论部分分享这些方法。欢迎所有反馈!
这导致API构架的流行,甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。...我以前写过一篇《理解RESTful架构》,探讨如何理解这个概念。 今天,我将介绍RESTful API的设计细节,探讨如何设计一套合理、好用的API。我的主要参考了两篇文章(1,2)。 ?...在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。...举例来说,有一个API提供动物园(zoo)的信息,还包括各种动物和雇员的信息,则它的路径应该设计成下面这样。...Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计,访问api.github.com会得到一个所有可用API的网址列表。
在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。...举例来说,有一个API提供动物园(zoo)的信息,还包括各种动物和雇员的信息,则它的路径应该设计成下面这样。
值得注意的是REST并没有一个明确的标准,而更像是一种设计的风格。 定义:简单来说REST是一种系统架构设计风格(而非标准),一种分布式系统的应用层解决方案。...在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。...举例来说,有一个API提供动物园(zoo)的信息,还包括各种动物和雇员的信息,则它的路径应该设计成下面这样。...返回完整的资源对象 PATCH /collection/resource:返回完整的资源对象 DELETE /collection/resource:返回一个空文档 十、Hypermedia API RESTful...Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计,访问api.github.com会得到一个所有可用API的网址列表。
什么是RESTful风格? 通过URL进行资源的定位,用HTTP动作(GET、POST、DELETE、PUSH)描述操作,完成功能。...遵循RESTful风格,可以使开发的接口通用性更好,统一规范,减少沟通、学习和开发的成本。...1、HTTP方法与CRUD动作的映射 动作 普通CRUD的URL Restful的URL Restful对应的HTTP方法 查询 Article?...2、RESTful API 2.1、查询列表 @RequestMapping(value = "/ArticleList", method = RequestMethod.GET) public List
因此,必须有一种统一的机制,方便不同的前端设备与后端进行通信,这导致 API 构架的流 行,甚至出现"API First"的设计思想,RESTful API 是目前比较成熟的一套互联网应用程序的 API...设计理论。...一个好的 RESTful API 我们应从以下几个方面考虑: 1.协议,建议使用更安全的https协议。 2.域名,尽量部署在专属域名下面。...路径,在RESTful架构中,每个网址代表一种资源(resource),所以网址中建议不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。
咱们设计的REST API真的nice么?...设计的一些原则。...URI的末尾不要添加“/” 多一个斜杠,语义完全不同,究竟是目录,还是资源,还是不确定而多做一次301跳转?...使用“-”提高URI的可读性 目的是使得URI便于理解,用“-”来连接单词 正面case:http://api.example.com/blogs/my-first-post 3..../api.college.com/student/3248234/course 最后,给后端研发工程师一个建议:清晰优雅的 RESTful API是为调用者编写的,别无脑随意定义一些shit一样的URI
RestFul接口设计 一、接口编程 1、背景 随着互联网的发展, 尤其是移动互联为代表的Web3.0时代. 客户端层出不穷, 以APP、微信、PC浏览器为代表, 服务端业务逻辑是基本一致的。
点击关注⬆️nginx⬆️,学习lnmp 本小编这一年是在一家移动互联网公司做App后端接口设计开发工作,最近组内做了一次很大的重构,就是把接口完全根据restful规范进行设计重写。...这么做的目的首先是减少和前端app同事的交流成本,其次是因为restful真的已经成为最流行的一种接口设计规范,像instagram、facebooke都在使用,下面是instagram提供的在线接口文档截图...本文只对restful 设计理论进行讲解,如果你真的决定使用它,有什么别的问题可以留言,比如用什么工具去设计api文档,等等。...主题开始登场: 目前互联网上充斥着大量的关于RESTful API(为方便,下文中“RESTful API ”简写为“API”)如何设计的文章,然而却没有一个”万能“的设计标准:如何鉴权?...API设计权衡上述几个原则。 需要强调的是:API的就是程序员的UI,和其他UI一样,你必须仔细考虑它的用户体验! 使用RESTful URLs 和action.
原文出处:RESTful API Design. Best Practices in a Nutshell. 原文:RESTful API Design....作者:Philipp Hauer 项目资源的URL应该如何设计?用名词复数还是用名词单数?一个资源需要多少个URL?用哪种HTTP方法来创建一个新的资源?可选参数应该放在哪里?...因为有太多的疑问,设计RESTful API变得很棘手。在这篇文章中,我们来看一下RESTful API设计,并给出一个最佳实践方案。...不要这么设计: /getAllEmployees /getAllExternalEmployees /createEmployee /updateEmployee 更好的设计: GET /employees...通常,RESTful Web服务将被JavaScript编写的客户端使用。
大部分Web应用采用的都是前后端分离模式,RESTful 接口设计方式是前后端分离的Web最常用的接口设计方式。...RESTful 接口设计方式定义了很多容易理解和方便实现的设计风格,通过接口文档,前端程序员和后端程序员可以顺畅沟通。通过接口文档,可以快速了解一个陌生项目的业务。...RESTful 接口设计方式不是一种必须遵守的语法或规则,只是采用这种方式,会享受到 RESTful 带来的种种便利,下面就开始详细了解 RESTful 。...三、RESTful 中URI路径的定义风格 所有的 Web 服务都使用 URI ,只是使用的方式不同。...RESTful 是一种设计风格,在使用时可以只遵守适合自己项目的规范,灵活应用。
restful风格接口 URL定位资源,用HTTP动词(GET,POST,DELETE,DETC)描述操作。...REST描述的是在网络中client和server的一种交互形式;REST本身不实用,实用的是如何设计 RESTful API(REST风格的网络接口); 2....Server提供的RESTful API中,URL中只使用名词来指定资源,原则上不使用动词。“资源”是REST架构或者说整个网络处理的核心。...1、REST 是面向资源的,这个概念非常重要,而资源是通过 URI 进行暴露。...比如:左边是错误的设计,而右边是正确的 GET /rest/api/getDogs --> GET /rest/api/dogs 获取所有小狗狗 GET /rest/api/addDogs --> POST