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

Rest api简介

IBM developerWorks 的文件服务标签云的 API REST API 请求,要求返回 XML 格式数据: GET https://www.ibm.com/developerworks...我们确实可以在 HTTP 的相应内容中描述是否成功,如果出错是因为什么, 然而, 这就意味着用户需要进行内容解析,才知道执行结果和错误原因。...使用 HTTP 头进行缓存处理 在 REST 的构架中,我们除了在与后台的数据交换中,需要有一个良好的缓存机制外,针对 REST API 请求都是在远端用 HTTP 发起这一特点,还需要为网络缓存进行更多考虑...IBM developerWorks 的带有电子标签的文件服务 API REST API 请求: GET https://www.ibm.com/developerworks/mydeveloperworks...,可以帮助我们更好的设计 REST API: 批量更新: 当用户需要更新多个资源的时候,你打算让开发者一次次的发送 HTTP 请求逐个更新吗?

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

    REST API设计指导——译自Microsoft REST API Guidelines(一)

    如果API的设计更规范更合理,在很大程度上能够提高联调的效率,降低沟通成本。那么什么是好的API设计?这里我们不得不提到REST API。...另外,REST API的书籍很多,但是完整完善实践丰富的设计指导并不多见,我们有幸看到了微软团队的作品——Microsoft REST API Guidelines,因此才有了此篇内容。...什么是REST API? Rest不是一种协议,也不是一种文字格式,更不是一种开发框架,它是一种系列的设计约束的集合:无状态性、将超媒体作为应用状态的引擎,这个约束我们统称Fielding约束。...简单的来说,在REST API:URL定位资源,用HTTP动词(GET,POST,PUT,DELETE)描述操作。前面说了,REST 指的是一组架构约束条件和原则。...为什么用REST API? 1.前后端分离主要以API为界做接洽的,这样就会有很多的API,API的表现力更强,更加便于理解。

    1.8K30

    REST API设计指导——译自Microsoft REST API Guidelines(三)

    前面我们说了,如果API的设计更规范更合理,在很大程度上能够提高联调的效率,降低沟通成本。那么什么是好的API设计?这里我们不得不提到REST API。...关于REST API的书籍很多,但是完整完善实践丰富的设计指导并不多见,我们有幸看到了微软团队的作品——Microsoft REST API Guidelines,因此才有了此篇内容。...5 Taxonomy 分类 As part of onboarding to Microsoft REST API Guidelines, services MUST comply with the taxonomy...Microsoft REST API 准则基本要求的一方面就是 服务的分类必须符合以下定义。...5.5 Long running API faults 长时间运行的API故障 For a Long Running API, it's possible for both the initial request

    1.7K30

    REST API设计指导——译自Microsoft REST API Guidelines(四)

    前言 前面我们说了,如果API的设计更规范更合理,在很大程度上能够提高联调的效率,降低沟通成本。那么什么是好的API设计?这里我们不得不提到REST API。...关于REST API的书籍很多,但是完整完善实践丰富的设计指导并不多见,我们有幸看到了微软团队的作品——Microsoft REST API Guidelines,因此才有了此篇内容。...上篇内容: REST API设计指导——译自Microsoft REST API Guidelines(三) 6 Client guidance 客户指导 To ensure the best possible...例如,当服务器返回的 JSON 对象中的字段顺序变了,客户端应当能够正确进行解析处理。...符合 Microsoft REST API 指南的 API 应该支持 PATCH 方法。

    3K50

    什么是REST API

    什么是REST API?...REST API是两个计算机系统在web浏览器和服务器中使用HTTP技术进行通信的一种方式。 在两个或多个系统之间共享数据一直是软件开发的一个基本要求。比如说,考虑购买汽车保险。...JSON响应是机器可读的,因此可以在输出HTML或其他格式之前被进行解析和使用。 REST APIs和Rest 多年来,各种数据通信标准已经发展起来。...在发出任何请求之前,通过向OAuth服务器发送一个客户ID和可能的客户秘密,获得一个令牌。然后,OAuth令牌会随每个API请求一起发送,直到过期。...REST API必须识别用户和他们的权利,但它可能不关心哪个应用程序在调用API。 REST API安全性 RESTful API提供了另一种访问和操作你的应用程序的途径。

    6K20

    Microsoft REST API指南

    Microsoft REST API指南 摘要 Microsoft REST API指南作为一种设计原则,鼓励应用程序开发人员通过RESTful HTTP接口访问资源。...本文档建立了 Microsoft REST API 开发人员应该遵循的指南, 以便统一一致地开发API。...例如,例如,当服务器返回的 JSON 对象中的字段顺序发生变化,客户端应当能够正确进行解析处理。 当服务端支持时,客户端可以请求以特定的顺序返回数据。...[…如果服务器接收到的请求目标比它希望解析的任何URI都长,那么它必须使用 414 (URI太长)状态代码进行响应。 服务如果能够生成超过2,083个字符的url,必须考虑兼容它支持的客户端。...符合Microsoft REST API准则的API应该支持PATCH。 7.4.3.

    6.2K11

    REST API 最佳实践

    在 Web 开发中,REST API 在确保客户端和服务器之间的顺利通信方面发挥了重要作用。 你可以把客户端看作是前端,把服务器看作是后端。...客户端(前端)和服务器(后端)之间的通信通常不是超级直接的。因此,我们使用一个叫作“应用编程接口”(或 API)的接口,作为客户端和服务器之间的中介。...任何遵循 REST 设计原则的 API 都被称为 RESTful API。 简单地说,REST API 是两台计算机通过 HTTP(超文本传输协议)进行通信的媒介,与客户端和服务器的通信方式相同。...例如,JavaScript 有一个内置的方法来通过 fetch API 解析 JSON 数据,因为 JSON 主要是为它而生成的。...但是如果你使用任何其他编程语言,如 Python 或 PHP,它们现在也都有解析和操作 JSON 数据的方法。

    2.8K20

    聊聊rest api设计

    序 本文主要研究下rest api的设计。 设计准则 easy to use & hard to misuse 易用不易误用,也就是api设计不要太复杂,要简单易用,而且还不能容易用错。...use case & document story api文档要围绕story或者use case来进行,在一个业务场景下提供完整的闭环操作。...防止文件下载目录遍历对于提供文件下载的接口,一定要避免目录遍历问题 服务质量保障 提供SLA 提供流量管理、熔断、限流 提供服务扩容机制 提供故障演练 提供审计功能 监控异常流量 提供调用方间的隔离 小结 rest...api的设计牵扯的方面比较多,本文暂时只是先列了一些,后续有待补充。...doc API设计要点 聊聊jpa的动态查询 使用RSQL实现端到端的动态查询

    1.3K10
    领券