首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

Rest api简介

IBM developerWorks 的文件服务标签云的 API REST API 请求,要求返回 XML 格式数据: GET https://www.ibm.com/developerworks...format=xml &scope=document&pageSize=30&sK=cloud&sO=dsc REST API 请求,要求返回 JSON 格式数据: GET https:/...使用 HTTP 头进行缓存处理 在 REST 的构架中,我们除了在与后台的数据交换中,需要有一个良好的缓存机制外,针对 REST API 请求都是在远端用 HTTP 发起这一特点,还需要为网络缓存进行更多考虑...通过更加灵活的使用这类链接元素,以及提供必要的数据冗余,我们可以大大简化开发者的编程逻辑,提高 REST API 的使用效率 回页首 更多的需要注意的细节与技巧 除了以上提到的方面,还有大量的细节与技巧...,可以帮助我们更好的设计 REST API: 批量更新: 当用户需要更新多个资源的时候,你打算让开发者一次次的发送 HTTP 请求逐个更新吗?

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

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

    什么是REST API

    什么是REST API?...REST API是两个计算机系统在web浏览器和服务器中使用HTTP技术进行通信的一种方式。 在两个或多个系统之间共享数据一直是软件开发的一个基本要求。比如说,考虑购买汽车保险。...API-Request.png REST API响应 响应的有效负载可以是任何实用的东西:数据、HTML、图像、音频文件等等。...不幸的是,这样就有必要维护多个历史API。旧的版本最终可以被废弃,但整个过程需要仔细规划。 REST API认证 上面显示的测试API是开放的:任何系统都可以在未经授权的情况下获取数据。...还有大量的公共REST API,集合了笑话、货币转换、地理编码、政府数据以及你能想到的每一个主题。许多是免费的,尽管有些需要你注册一个API密钥或使用其他认证方法。

    4.3K20

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

    前面我们说了,如果API的设计更规范更合理,在很大程度上能够提高联调的效率,降低沟通成本。那么什么是好的API设计?这里我们不得不提到REST API。...关于REST API的书籍很多,但是完整完善实践丰富的设计指导并不多见,我们有幸看到了微软团队的作品——Microsoft REST API Guidelines,因此才有了此篇内容。...Microsoft REST API 准则基本要求的一方面就是 服务的分类必须符合以下定义。...错误,或更具体的服务错误,被定义为客户端将无效数据传递给服务并且服务明确地拒绝该数据。...译者注:故障意味着服务端代码出现故障,可能会影响整体的API使用。比如数据库连接超时。

    1.1K30

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

    前言 前面我们说了,如果API的设计更规范更合理,在很大程度上能够提高联调的效率,降低沟通成本。那么什么是好的API设计?这里我们不得不提到REST API。...关于REST API的书籍很多,但是完整完善实践丰富的设计指导并不多见,我们有幸看到了微软团队的作品——Microsoft REST API Guidelines,因此才有了此篇内容。...符合 Microsoft REST API 指南的 API 应该支持 PATCH 方法。...Accept-Encoding  | Gzip, deflate | 在适用时,REST API应支持GZIP和deflate 。对于非常大的资源,服务可以忽略和返回未压缩的数据。...PS:Gzip, deflate 是常用的HTPP压缩方式,对于REST API,也是可以支持HTTP动态压缩的。不过如果数据量比较大,压缩会比较消耗CPU资源。所以对于大数据,请慎重。

    2K50

    REST API 最佳实践

    在这篇文章中,我将带你了解创建 REST API 时需要遵循的一些最佳实践。这将帮助你创建最好的 API,并使你的 API 用户使用起来更容易。 0.什么是 REST API?...1.REST API 设计建议 1.用名词表示资源 当你设计一个 REST API 时,你不应该在端点路径中使用动词。端点应该使用名词,表示它们各自的作用。...你可以把你的 API 的数据看成是来自用户的不同资源的集合。...如果发生这种情况,从这样的数据库中检索数据可能非常缓慢。 过滤、排序和分页都是可以在 REST API 的集合上执行的操作。这样只能检索、排序和排列必要的数据,并将其分页,以防服务器请求过载。...表示永久移动 4XX 客户端错误,如 400 表示错误的请求,404 表示未找到资源 5XX 服务器端错误,如 500 表示内部服务器错误 13.提供有用的错误消息 除了提供恰当的HTTP状态代码外

    1.7K20

    聊聊rest api设计

    序 本文主要研究下rest api的设计。 设计准则 easy to use & hard to misuse 易用不易误用,也就是api设计不要太复杂,要简单易用,而且还不能容易用错。...版本不建议版本化,建议采用新的领域命名才与原有的api区分开来 输出规范 返回码遵循http的返回码规范,4xx表示客户端错误,5xx表示服务端错误。...一般返回jsonObject,通常会携带code,error之类的 返回jsonObject的字段success表示请求是否成功,data表示数据,msg表示消息描述,error描述错误信息详情。...错误信息格式type表示错误异常类型,code表示错误编号用于个性化错误提示,msg用于错误信息描述,link提供该错误信息的具体描述页面 安全相关 调用方鉴权对于api的消费者,要求调用的时候强制提供...防止文件下载目录遍历对于提供文件下载的接口,一定要避免目录遍历问题 服务质量保障 提供SLA 提供流量管理、熔断、限流 提供服务扩容机制 提供故障演练 提供审计功能 监控异常流量 提供调用方间的隔离 小结 rest

    96910

    快速模拟 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...title": "测试 json-server", "author": "dys" } ] 还可以访问某一条信息,如 http://localhost:3000/posts/1,只返回一条数据

    2K40

    REST API工具推荐

    Talend API Tester 是专用于测试 HTTP 和 REST API 的工具。...如果你需要在 REST 服务中采用 SOAP 服务,或者你消费 API但想通过中间人公开 API 的后端服务,它会为你提供具有许多策略选项(配额、身份验证、数据中介、缓存)的代理向导。。...其主要使用场景有: 通过一个平台构建、托管和管理多个 API 跨多个技术端点消费和编排数据 加快 API 开发 简化现有的 API Linx 在创建或调用内部和外部 REST Web 服务方面特别强大。...它是扩展需与其他技术集成的 API 的最快方法(例如,你需要将数据加载或推送到数据库中、建立紧密联系、推送更新以通知通知流、随时修改或加密数据等)。...除了 REST 之外,Linx 还提供了从数据库到加密和云的多项功能,为 API 与多种技术的集成提供了无数种可能性。Linx IDE Designer 是执行测试和服务调用的绝佳免费选项。

    2.5K30

    什么是REST API ?

    什么是REST API ? 前言 作者:神的孩子都在歌唱 一. REST简介 REST 是 Internet 上计算机之间最常见的通信标准。 API 代表应用程序编程接口。...大多数移动和 Web 应用程序用于与服务器通信的通用 API 标准称为 REST。...这是一套新的规则,自 2000 年代初以来一直是构建 Web API 的通用标准。遵循 REST 标准的 API 称为 RESTful API。...一个良好实现的 RESTful API 会返回正确的 HTTP 状态代码。 • 200 状态码: 表示请求成功。 • 400状态码: 意味着我们的请求有问题。例如,请求包含不正确的语法。...REST 实现应该是无状态的。这意味着双方不需要存储任何关于彼此的信息。 2. 服务器返回大量数据,请使用分页。常见的分页方案使用**“limit”和“offset”**作为参数。 /books?

    5100

    Flink监控 Rest API

    Flink 自己的仪表板也使用了这些监控 API,但监控 API 主要是为了自定义监视工具设计的。监控 API 是 REST-ful API,接受 HTTP 请求并返回 JSON 数据响应。...REST API 已版本化,可以通过在 URL 前面加上版本前缀来查询特定版本。前缀始终采用 v [version_number] 的形式。.../jobs/:jobid/plan 查看作业的数据流执行计划: http://localhost:8090/v1/jobs/719ca461851b0afad055d81309b945a8/plan...其他 在这简单罗列了一部分 API,更详细的可以参阅 Monitoring REST API: API 说明 参数 /jobs/:jobid/accumulators 查看具体某个作业所有任务的累加器...truncated为true表示异常信息太大,截断展示。 jobid /jobs/:jobid/savepoints 触发生成保存点,然后有选择地取消作业。

    3.7K20
    领券