首页
学习
活动
专区
圈层
工具
发布

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

而RESTful API 在请求方法、资源、地址都进行了规范,其最大限度的利用了HTTP最初的应用协议的设计理念。...使用RESTful 设计RESTful API 资源路径(URI):RESTful的核心是面向资源,如何规划资源路径很重要 HTTP动词(请求方式):如get,post,delete,put...过滤信息:例如获取资源列表时有分页操作/查询操作,这时要合理分配过滤信息,过滤信息设置太多,有可能会违反RESTful API 关于URI方面的限定。...当然,处理RESTful API设计思想,还有最近流行的GraphQL,它是一种API查询语言,其将所见即所得的思想引入,能帮助提升开发的体验与应用的性能。...(参考:http://graphql.cn/ ) 参考 慕课教程 Restful API 的设计规范 理解RESTful架构 RESTful架构基础

2.3K20
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    Spring Boot 实战|RESTful API 构建示例

    本文就来演示一下Spring boot如何实现这种模式,本文重点会讲解如何设计一个Restful的API,并通过Spring boot来实现相关的API。...不过,为了大家更好的了解Restful风格的API,我们先设计一个传统的数据返回接口,这样大家可以对比着来理解。...2、Restful API设计 好了,我们现在再来看看如何实现Restful API。实际上Restful本身不是一项什么高深的技术,而只是一种编程风格,或者说是一种设计风格。...而Restful API的设计则通过HTTP的方法来表示CRUD相关的操作。...下面是我设计的一组对文章的增删改查的Restful API: ? 这里可以看出,URL仅仅是标识资源的路劲,而具体的行为由HTTP方法来指定。

    2.8K20

    RESTful API

    一、 什么是RESTful REST与技术无关,代表的是一种软件架构风格,REST是Representational State Transfer的简称,中文翻译为“表征状态转移” REST从资源的角度类审视整个网络...接口有两个用途: - 为别人提供服务 - 前后端分离,一个写vue,一个写后端,他们之间都是通过ajax请求 三、RESTful API设计 网络应用程序,分为前端和后端两个部分。...这导致API构架的流行,甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。...在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。...超媒体API RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么。

    1.9K20

    RESTful API

    RESTful架构是一种流行的互联网软件架构,它结构清晰,符合标准,易于理解,扩展方便。 REST是Representational State Transfer的缩写,翻译为“表现层状态转化”。...总结什么是RESTful架构 每一个URI代表一种资源 客户端和服务端之间传递这种资源的某种表现层 客户端通过HTTP动词(GET,POST,PUT,DELETE)对服务端资源进行操作,实现表现层状态转换...https://api.example.com 如果确定API很简单,不会用进一步扩展,则可以考虑放在主域名下 https://example.org/api/ 版本 应该将API的版本号放入...RESTful API最好做到Hypermedia,即返回结果中提供链接,指向其他API方法,是的用户不查文档,也知道该怎么做。...rel表示这个API与当前网址的关系(collection关系,并给出该collection的网址),href表示API的路径,title表示API的标题,type表示返回类型 Hypermedia API

    1.2K10

    RESTFUL API

    REST 意思是:表述性状态传递(英文:Representational State Transfer) RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。...API与用户的通信协议,总是使用HTTPs协议 应该尽量将API部署在专用域名之下:https://api.example.com 如果确定API很简单,不会有进一步扩展,可以考虑放在主域名下。...在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。...RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么。...Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计,访问api.github.com会得到一个所有可用API的网址列表。

    89560

    RESTful API 主流API风格

    RESTful 入门 一、什么是Restful REST 是 Representational State Transfer 的缩写,如果一个架构符合 REST 原则,就称它为 RESTful 架构 RESTful...架构可以充分的利用 HTTP 协议的各种功能,是 HTTP 协议的最佳实践 RESTful API 是一种软件架构风格、设计风格,可以让软件更加清晰,更简洁,更有层次,可维护性更好二、RESTful...API 请求设计要按照:请求 = 动词 + 宾语 动词:使用五种 HTTP 方法,对应 CRUD 操作。...3xx 状态码 API 用不到301状态码(永久重定向)和302状态码(暂时重定向,307也是这个含义),因为它们可以由应用级别返回,浏览器会直接跳转,API 级别可以不考虑这两种情况。...API 主要是用303 See Other,表示参考另一个 URL。

    3.3K11

    RESTful 架构以及 RESTful API开发

    在周三的测试运维试听课程中,芒果给大家介绍了RESTful架构以及RESTful API开发-Django REST Framework,这里我们来做个小总结。 什么是REST 什么是REST?...RESTful架构 那么什么又是RESTful架构呢? 如果一个架构符合REST的约束条件和原则,我们就称它为RESTful架构。...RESTful API 由于现在前端系统的复杂多样性(手机、平板、桌面电脑、其他专用设备......),导致现在系统需要有一种统一的机制,方便不同的前端设备与后端进行通信。...作为一套比较成熟的互联网应用程序的API设计理论,RESTful API是目前最流行的API设计方式。...RESTful API开发一般需要重点关注以下几点: URL 设计 动词 + 宾语:RESTful 的核心思想就是,客户端发出的数据操作指令都是"动词 + 宾语"的结构。

    96840

    浅谈 RESTful API

    而RESTful API就是目前比较成熟的的一套应用程序API设计理论。 目的:Client和Server端进一步解耦。 应用:最为经典的莫过于github API。...PS:使用HTTPS协议和RESTful API本身没有多大关系,但是对于增加网站的安全是非常重要的,特别是如果提供的是公开的API,那么HTTPS久更显得重要了。...9、Hypermedia API Restful API的设计最好做到Hypermedia:即在返回结果中提供相关资源的链接,连向其他API方法,使用户不需要查文档也知道下一步做什么。...四、参考 http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm http://cizixs.com/2016/12/12/restful-api-design-guide...https://bungder.github.io/2017/07/24/REST https://www.zcfy.cc/article/restful-api-design-best-practices-in-a-nutshell

    1.1K10

    Restful API详解

    Restful API介绍 Restful API是一种网络应用程序的设计风格和开发方式,基于HTTP,可以使用XML格式定义或JSON格式定义,它使用URL定位资源,用HTTP动词(GET...Restful API特点 用URL描述资源。 使用HTTP方法描述行为,使用HTTP状态码表示不同的结果。 使用json交互数据。 Restful只是一种风格,并不是强制的标准。...Restful API的成熟模型 ? Level 0:使用HTTP作为传输方式。 Level 1:引入资源概念,每一个资源都有对应的URL。...Restful API常用映射注解 @Controller:在一个类上添加@Controller注解,表明了这个类是一个控制器类。...Restful API的测试用例 在我们实际开发中,需要对我们的接口进行测试,确保我们后端接口的可用,这时我们在不启动整个项目的情况下,可以利用到spring的测试框架辅助我们的开发。

    2.5K30

    ‍Java OCR技术全面解析:六大解决方案比较

    正文 OCR解决方案概览 OCR技术的选择多样,本节将介绍六种不同的Java OCR解决方案,它们分别是: Tesseract OCR Google Vision API Amazon Textract...Amazon Textract 依赖引入: 由于Amazon Textract是一个AWS云服务,主要通过AWS SDK进行访问,因此需要添加AWS SDK到项目中。 <!...Microsoft Azure OCR 依赖引入: 与Amazon Textract类似,Azure OCR通过Azure Cognitive Services提供,主要通过HTTP请求调用。...集成复杂度: 作为云服务,集成相对简单,但需要处理API调用和网络延迟。 3. Amazon Textract 社区支持: 作为AWS服务之一,提供全面的文档和技术支持。...对于需要处理大量文档、追求高准确率的企业级应用,Google Vision API、Amazon Textract和ABBYY FineReader等服务可能更合适。

    4.8K20

    Amazon对接选EDI还是API

    1140-amazon-phone.imgcache.rev.web.900.518.jpg 那么作为供应商,应该选择EDI还是API?...对接A的API,你可能需要把数据base64加密后放在body中的某一个字段上,对于B的API,你可能需要先获取一下动态的token,然后把数据md5哈希后加在URL中,每对接一家新的企业,你可能需要重新开发调用...API的代码。...如果是API,则需要供应商定时去调用接口获取数据,而且API接口一般会限制调用次数。而EDI的主动推送则更符合业务上的逻辑,也可以更加稳定地接收大批量的数据。...而对于API来说,没有标准的数据结构,每家企业之间的差别也比较大。很多API在涉及数据结构的时候也参考了EDI的报文结构。

    80920

    RESTful API 设计指南

    这导致API构架的流行,甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。...我以前写过一篇《理解RESTful架构》,探讨如何理解这个概念。 今天,我将介绍RESTful API的设计细节,探讨如何设计一套合理、好用的API。我的主要参考了两篇文章(1,2)。...在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。...RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么。...转自:http://www.ruanyifeng.com/blog/2014/05/restful_api.html

    87140

    RESTful API 设计指南

    这导致API构架的流行,甚至出现"API First"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。...我以前写过一篇《理解RESTful架构》,探讨如何理解这个概念。 今天,我将介绍RESTful API的设计细节,探讨如何设计一套合理、好用的API。我的主要参考了两篇文章(1,2)。...在RESTful架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。...RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么。...Hypermedia API的设计被称为HATEOAS。Github的API就是这种设计,访问api.github.com会得到一个所有可用API的网址列表。

    77810

    RESTful API 最佳实践

    思维导图摘要 一、 RESTful API 设计的 6 项基本原则 重点: 本节给出了在设计 RESTful API 接口时需要遵循的基本原则。...统一接口 无状态 可缓存 C/S 架构 分层系统 按需编码(可选) 二、 实战小贴士 本节给出了有关 RESTful API 接口设计技巧速查表,可助你快速了解如何设计出最佳的 API 接口。...三、 HTTP 请求方法 重点: 本节讲解 HTTP 请求方法在 RESTful API 接口设计时的使用方法。...六、 资料 福利:有关 RESTful API 教程和相关知识点资料可以从这里获取。 导图 在线版 RESTful 服务最佳实践 思维导图。 图片预览版 ?...感谢 感谢 原作者 tfredrich 和 译者 提供如此优秀的 RESTful API 设计教程。

    1.1K20
    领券