首页
学习
活动
专区
圈层
工具
发布
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    Rest api简介

    IBM developerWorks 的文件服务标签云的 API REST API 请求,要求返回 XML 格式数据: GET https://www.ibm.com/developerworks...使用 HTTP 头进行缓存处理 在 REST 的构架中,我们除了在与后台的数据交换中,需要有一个良好的缓存机制外,针对 REST API 请求都是在远端用 HTTP 发起这一特点,还需要为网络缓存进行更多考虑...IBM developerWorks 的带有电子标签的文件服务 API REST API 请求: GET https://www.ibm.com/developerworks/mydeveloperworks...比如当用户 Alice 和 Bob 通过 REST 获取了一篇文档。...,可以帮助我们更好的设计 REST API: 批量更新: 当用户需要更新多个资源的时候,你打算让开发者一次次的发送 HTTP 请求逐个更新吗?

    2.6K60

    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.4K30

    Microsoft REST API指南

    Microsoft REST API指南 摘要 Microsoft REST API指南作为一种设计原则,鼓励应用程序开发人员通过RESTful HTTP接口访问资源。...5.5 长期运行API故障 对于长期运行的 API,很可能出现第一次请求成功,且后续每次去获取结果时 API 也处于正常运行(每次都回传 200)中,但其底层操作已经失败了的情况。...符合Microsoft REST API准则的API应该支持PATCH。 7.4.3....从集合的角度来看,添加或更新的实体之间没有区别。 删除的实体仅使用其“id”和“@removed”节点表示。 “@removed”节点的存在必须表示从集合中删除条目。 10.3....从定义的集合中删除的条目必须包含在响应中。 从集合中删除的项必须仅使用它们的“id”和“@remove”节点表示。 10.5.

    5.5K11

    什么是REST API

    什么是REST API?...REST API示例 在你的浏览器中打开以下链接,从Open Trivia Database[3]中请求一个随机的计算机问题: https://opentdb.com/api.php?...id=123 所有这些都是为用户123获取数据的有效选项。当你有更复杂的操作时,组合的数量会进一步增加。 归根结底,你如何格式化URL并不重要,但整个API的一致性很重要。...不幸的是,这样就有必要维护多个历史API。旧的版本最终可以被废弃,但整个过程需要仔细规划。 REST API认证 上面显示的测试API是开放的:任何系统都可以在未经授权的情况下获取数据。...最多组成10个/author/{id}请求以获取每个作者的详细信息。 这被称为「N+1问题」;必须为父请求中的每个结果提出N个API请求。

    5.2K20

    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...符合 Microsoft REST API 指南的 API 应该支持 PATCH 方法。...表的请求头应该遵循微软REST API服务规范。使用这些标头不是必须的,但是如果用到,那么它们必须使用一致。

    2.5K50

    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 准则基本要求的一方面就是 服务的分类必须符合以下定义。...对于长时间运行的 API,很可能出现初始请求成功,且后续每次去获取结果时 API 也处于正常运行(每次都回传 200)中,但其底层操作已经失败了的情况。

    1.4K30

    REST API 最佳实践

    在这篇文章中,我将带你了解创建 REST API 时需要遵循的一些最佳实践。这将帮助你创建最好的 API,并使你的 API 用户使用起来更容易。 0.什么是 REST API?...任何遵循 REST 设计原则的 API 都被称为 RESTful API。 简单地说,REST API 是两台计算机通过 HTTP(超文本传输协议)进行通信的媒介,与客户端和服务器的通信方式相同。...1.REST API 设计建议 1.用名词表示资源 当你设计一个 REST API 时,你不应该在端点路径中使用动词。端点应该使用名词,表示它们各自的作用。...获取:使用 GET 方法获取资源。GET 请求从不改变资源的状态。无副作用。GET 是幂等的。GET 具有只读的含义。因此,你可以完美的使用缓存。 创建:使用 POST 创建新的资源(非幂等)。...HATEOAS 是 Hypermedia As The Engine Of Application State 的缩写,从字面上理解是 “超媒体即是应用状态引擎” 。

    2.3K20

    聊聊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.2K10

    快速模拟 Rest API

    在前后端开发过程中,通常会通过 web api 进行沟通,Rest 风格和 JSON结构是常用的,例如前端要获取文章列表,需要通过 GET /post 来取得数据,返回的数据例如 { "posts"...: [ { "id": 1, "title": "test", "author": "me" }, ...... ] } 后端来定义路由和返回JSON数据 开发中,后端实现API的速度可能不能满足前端开发的速度...,前端为了不必等待后端,可以自己来模拟这个API,按照规定好的数据结构来返回模拟数据 json-server 就是用来实现这个需求的,不用自己写任何代码,把自己需要的模拟数据写入一个JSON文件,json-server...可以加载这个文件,并对外提供REST风格的访问方式,下面通过示例看具体的使用方式 先通过 npm 安装 json-server npm install -g json-server 然后自定义一个JSON

    2.2K40

    REST API工具推荐

    它可以: 从源代码控制、文件和 URL 导入 API。 与你的 GitHub、GitLab 或 Bitbucket 帐户集成。 预览实时文档。...这是我个人最喜欢的工具之一,因为它是我用来测试自己 API 的第一个工具,而且学习它的过程再顺利不过了。该产品功能全面,涵盖了从创建到测试和监视的 API 开发流程。...你还可以添加基本的 API 监视器(每分钟、每小时或每周运行一次),并获取关于失败的电子邮件通知。 ? Ping API 是功能强大的 API 检查器。...Talend API Tester 是专用于测试 HTTP 和 REST API 的工具。...除了 REST 之外,Linx 还提供了从数据库到加密和云的多项功能,为 API 与多种技术的集成提供了无数种可能性。Linx IDE Designer 是执行测试和服务调用的绝佳免费选项。

    2.9K30
    领券