文档建议反馈控制台
首页
学习
活动
专区
圈层
工具
MCP广场
文章/答案/技术大牛
发布

Rest api简介

IBM developerWorks 的文件服务标签云的 API REST API 请求，要求返回 XML 格式数据： GET https://www.ibm.com/developerworks...回页首 正确的使用 HTTP 响应代码 作为 API 的设计者，正确的将 API 执行结果和失败原因用清晰简洁的方式传达给客户程序是十分关键的一步。...服务器返回此响应时，会自动将请求者转到新位置。 302 重定向 , 请求的网页临时移动到新位置，但求者应继续使用原有位置来进行以后的请求。302 会自动将请求者转到不同的临时位置。...使用 HTTP 头进行缓存处理 在 REST 的构架中，我们除了在与后台的数据交换中，需要有一个良好的缓存机制外，针对 REST API 请求都是在远端用 HTTP 发起这一特点，还需要为网络缓存进行更多考虑...，可以帮助我们更好的设计 REST API： 批量更新： 当用户需要更新多个资源的时候，你打算让开发者一次次的发送 HTTP 请求逐个更新吗？

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

    使用 %REST.API 类创建 REST 服务

    本章介绍如何使用 %REST.API 类来创建、更新和删除 REST 服务。...使用 %REST.API 类创建或更新 REST 服务创建 REST 服务的推荐方法是从 REST 服务的 OpenAPI 2.0 规范开始，并使用它来生成 REST 服务类。...要使用 %REST.API 类执行此操作：获取 REST 服务的 OpenAPI 2.0 规范，采用 JSON 格式，并将规范保存为文件。该文件必须是 UTF-8 编码的。...如果该方法更新现有应用程序，IRIS 将重新生成给定包中的 disp 和 spec 类并更新 impl 类，保留对该类所做的编辑。如果 OpenAPI 2.0 规范无效，则该方法不会进行任何更改。...使用 %REST.API 类删除 REST 服务要使用 %REST.API 类删除 REST 服务：在可以找到 REST 服务的命名空间中，调用 %REST.API 类的 DeleteApplication

    2.4K20

    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 Notes-将REST应用于URI

    摘要: 自1994年以来，REST架构风格就被用来指导现代Web架构的设计和开发，本篇描述了在创作超文本移交协议(HTTP)和统一资源标识符(URI)两个互联网规范的过程中，以及将这些技术部署在libwww-perl...客户端库、Apache HTTP服务器项目、协议标准的其他实现的过程中，应用REST所学到的经验和教训 正文: 将REST应用于URI Web标准化 开发REST的动机是为Web的运转方式创建一种架构模式...其中承载包含应用状态的部分是有超媒体来负责的，这也是为什么REST强调HATEOAS（Hypermedia As The Engine Of Application Statue）的原因所在 将REST...应用于URI REST既被用来为URI规范定义“资源”这个术语，也被用来定义通过它们的表述来操作资源的通用接口的全部语义 重新定义资源 早期Web架构将URI定义为文档的标识符，创作者往往是根据网络上一个文档的位置来定义标识符...创作者需要的是一个能够与通过超媒体引用来表达的语义紧密匹配的标识符，允许这个引用保持静态，甚至是在访问该引用的结果可能会随时间而变化的情况下，REST通过将一个资源定义为创作者想要标识的语义，而不是创建引用时那些语义的对应值

    84330

    什么是REST API

    什么是REST API？...amount=1&category=18[4] 这是一个作为RESTful网络服务实现的公共API（它遵循REST公约）。你的浏览器将展示一个单独的JSON格式的问答问题，并附有答案。...这对于访问私有数据或允许更新和删除请求的API是不可行的。 与RESTful API处于同域的客户端应用程序将像其他HTTP请求一样发送和接收cookies。...API身份验证将根据使用上下文而有所不同： 在某些情况下，第三方应用程序被视为像任何其他具有特定权利和权限的登录用户。例如，一个地图API可以将两点之间的方向返回给调用的应用程序。...REST API必须识别用户和他们的权利，但它可能不关心哪个应用程序在调用API。 REST API安全性 RESTful API提供了另一种访问和操作你的应用程序的途径。

    6K20

    REST API设计指导——译自Microsoft REST API Guidelines（三）

    前面我们说了，如果API的设计更规范更合理，在很大程度上能够提高联调的效率，降低沟通成本。那么什么是好的API设计？这里我们不得不提到REST API。...关于REST API的书籍很多，但是完整完善实践丰富的设计指导并不多见，我们有幸看到了微软团队的作品——Microsoft REST API Guidelines，因此才有了此篇内容。...由于公众号文章内容字数有限，因此我们将翻译稿拆分并分享出来，并且给出英文对照。翻译的不对之处，请多多指教。 另外，由于本周聚焦在架构层面，下周我们争取录制更多教程并分享出来。...Microsoft REST API 准则基本要求的一方面就是 服务的分类必须符合以下定义。...错误，或更具体的服务错误，被定义为客户端将无效数据传递给服务并且服务明确地拒绝该数据。

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

    3K50

    Rest Notes-将REST应用于HTTP

    正文: 将REST应用于HTTP 超文本移交协议(HTTP)在Web架构中既作为在Web组件之间通信的主要的应用级协议，也作为特别为移交资源的表述而设计的唯一的协议(现在并不是唯一，还有COAP协议)。...REST用来识别早期HTTP协议中的问题，并指定了一个可以和HTTP1.0互操作的协议子集，然后分析HTTP1.1的扩展提议，并最终诞生了HTTP1.1 可扩展性 REST的主要目标之一是在一个已部署的架构中支持逐渐的和片段的修改...协议版本控制 通过主版本和次版本号来区分（1.0 1.1 2.0），其版本信息代表的是消息发送者对协议的支持能力 可扩展的协议元素 通过将解析和转发HTTP消息的规则与新的HTTP协议元素的相关语义分离开...，解决了中间组件更新部署问题 扩大了响应码区间，100-599 升级 HTTP1.1新增了Upgrade头，用来再通信双方进行协商协议版本 自描述的信息 REST要求组件之间消息是自描述的，...在HTTP中的不匹配 在HTTP协议中存在一些架构不匹配，一些是由于标准过程之外部署的第三方扩展所导致的，其他的则是由于与已部署的HTTP/1.0组件保持兼容的必要性所导致的 区分非权威的响应 没有一致的机制来区分一个响应是来自于源服务器还是中间的某一个组件

    92830

    REST API 最佳实践

    在这篇文章中，我将带你了解创建 REST API 时需要遵循的一些最佳实践。这将帮助你创建最好的 API，并使你的 API 用户使用起来更容易。 0.什么是 REST API？...还有其他非 HTTP 标准动词，如 COPY、PURGE、LINK、UNLINK 等等。...创建：使用 POST 创建新的资源（非幂等）。 更新：使用 PUT 更新整个资源，PATCH 将部分修改应用于资源。PUT 和 PATCH 都是幂等的。...因此，GET 将检索资源，POST 将创建资源，PUT 将更新整个资源，DELETE 将删除资源，PATCH 更新资源的局部数据。 5.用过滤、排序和分页请求数据 有时，API 的数据库可能非常大。...param1=23¶m2=432 在这种情况下，API响应不会返回任何资源。而是执行一个操作并将结果返回给客户端。因此，您应该在URL中使用动词而不是名词，来清楚的区分资源请求和非资源请求。

    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

    快速模拟 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.4K40
    点击加载更多

    相关资讯

    热门标签

    更多标签

    活动推荐

      运营活动

      活动名称
      广告关闭

      腾讯云开发者

      扫码关注腾讯云开发者

      扫码关注腾讯云开发者

      领取腾讯云代金券

      热门产品

      热门推荐

      更多推荐

      Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有

      深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 粤公网安备44030502008569号

      腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号

      领券