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

    Rest api简介

    理解和使用内容协商 我们的开发者在发送一个 REST API 请求的同时,根据应用场景,针对相同的资源,可能会期待不同的返回形式。 比如,我希望根据用户客户端语言,同一个资源的内容可以返回不同的语言。...因此,我们在设计 REST API 的时候,应该提供完备的内容协商能力。 使用 URL 参数进行内容协商 最容易想到的自然是通过 URL 参数进行控制,我们经常看到形如 / 航班号 /entry?...410 已删除 , 如果请求的资源已被永久删除,那么,服务器会返回此响应。 412 未满足前提条件 , 服务器未满足请求者在请求中设置的其中一个前提条件。...比如当用户 Alice 和 Bob 通过 REST 获取了一篇文档。...文档服务: 是否由于 API 持续更新,使得客户端连接不同版本服务的时候疲于奔命?尝试着把你的 API 定义规范成 XML 文档,这样客户端很容易理解当前服务可以提供哪些功能,以及如何使用这些功能。

    3K60

    Spring Cloud Task 任务执行-通过调用 REST API 启动任务

    Spring Cloud Task提供了REST API来启动任务。通过REST API启动任务使我们能够从其他应用程序或脚本中启动任务,从而进一步提高了任务的可用性和灵活性。...创建任务在使用REST API启动任务之前,我们需要先定义一个任务。...以下是使用REST API启动任务的示例:POST /tasks/execute?...我们还可以通过在请求正文中添加任务参数来传递任务参数。例如,以下是使用REST API传递任务参数的示例:POST /tasks/execute?...任务执行逻辑可以通过使用@Value注释将这些参数注入到任务中来使用这些参数。监控和管理任务一旦启动了任务,我们可以使用Spring Cloud Task提供的API和UI来监控和管理任务。

    1.7K20

    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,因此才有了此篇内容。...Microsoft REST API 准则基本要求的一方面就是 服务的分类必须符合以下定义。...错误不会影响整体 API 的可用性。 译者注:错误可以理解成客户端参数错误,通常返回“4XX”状态码,并不影响整体的API使用。...延迟定义为具体 API 被调用完成所需的时长, 尽可能使用客户端调用进行测量。

    1.7K30

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

    前言 前面我们说了,如果API的设计更规范更合理,在很大程度上能够提高联调的效率,降低沟通成本。那么什么是好的API设计?这里我们不得不提到REST API。...关于REST API的书籍很多,但是完整完善实践丰富的设计指导并不多见,我们有幸看到了微软团队的作品——Microsoft REST API Guidelines,因此才有了此篇内容。...: 为了保证与 REST API 服务进行对接的客户端有更佳的体验,客户端应该遵循以下最佳实践: 6.1 Ignore rule  忽略规则 For loosely coupled clients where...符合 Microsoft REST API 指南的 API 应该支持 PATCH 方法。...当对资源属性不了解的客户端试图通过 PUT 更新数据时,由于对属性不了解,很可能忽略了某些属性,进而导致这些属性被无意删除。

    3K50

    Microsoft REST API指南

    Microsoft REST API指南 摘要 Microsoft REST API指南作为一种设计原则,鼓励应用程序开发人员通过RESTful HTTP接口访问资源。...让所有应用开发者都可以轻松的通过REST接口访问Micosoft服务。 允许Service开发者利用其他Service的基础上来开发一致的REST API端点。...CORS 跨域 符合Microsoft REST API准则的服务必须支持CORS(跨源资源共享)。 服务应该支持CORS *的允许起源,并通过有效的OAuth令牌强制授权。...服务可以向“@remove”节点添加额外的元数据,例如删除的原因或“removed at”时间戳。我们建议团队与Microsoft REST API指导原则工作组协调,以帮助维护一致性。...从集合中删除的项必须仅使用它们的“id”和“@remove”节点表示。 10.5. Using a delta link 客户端通过调用delta链接上的GET方法请求更改。

    6.2K11

    什么是REST API

    API(应用程序接口)通过为系统之间的对话提供接口来帮助这种类型的通信。REST只是一种被广泛采纳的API风格,我们用它来与内部和外部以一种一致的和可预测的方式进行沟通。...「无状态」(Stateless):REST是无状态的:客户端请求应该包含响应所需的所有信息。...更新更新已存在的记录DELETE删除删除已存在的记录 比如: 对/user/的GET请求返回系统中的注册用户列表。...这对于访问私有数据或允许更新和删除请求的API是不可行的。 与RESTful API处于同域的客户端应用程序将像其他HTTP请求一样发送和接收cookies。...在发出任何请求之前,通过向OAuth服务器发送一个客户ID和可能的客户秘密,获得一个令牌。然后,OAuth令牌会随每个API请求一起发送,直到过期。

    6K20

    聊聊rest api设计

    序 本文主要研究下rest api的设计。 设计准则 easy to use & hard to misuse 易用不易误用,也就是api设计不要太复杂,要简单易用,而且还不能容易用错。...版本不建议版本化,建议采用新的领域命名才与原有的api区分开来 输出规范 返回码遵循http的返回码规范,4xx表示客户端错误,5xx表示服务端错误。...防止文件下载目录遍历对于提供文件下载的接口,一定要避免目录遍历问题 服务质量保障 提供SLA 提供流量管理、熔断、限流 提供服务扩容机制 提供故障演练 提供审计功能 监控异常流量 提供调用方间的隔离 小结 rest...api的设计牵扯的方面比较多,本文暂时只是先列了一些,后续有待补充。...doc API设计要点 聊聊jpa的动态查询 使用RSQL实现端到端的动态查询

    1.3K10

    REST API工具推荐

    此外,你可以为大多数相关技术(从 ASP.NET Core 和 Kotlin 到 Node.JS 和 Python)生成服务端或客户端存根。 ?...Talend API Tester 是专用于测试 HTTP 和 REST API 的工具。...3将 API 推向世界 Apigee 是一个在线平台,你可以通过它的门户为消费者构建、管理、消费 API并公开其功能。...如果你需要在 REST 服务中采用 SOAP 服务,或者你消费 API但想通过中间人公开 API 的后端服务,它会为你提供具有许多策略选项(配额、身份验证、数据中介、缓存)的代理向导。。...其主要使用场景有: 通过一个平台构建、托管和管理多个 API 跨多个技术端点消费和编排数据 加快 API 开发 简化现有的 API Linx 在创建或调用内部和外部 REST Web 服务方面特别强大。

    3.2K30

    REST API 还是 GraphQL?

    前言 说到 API 设计,GraphQL 和 RESTful API 是当前最主流的两种选择,各自有其独特优势与挑战。...聚合查询 还有个好处是,它通过 Schema 统一前后端对接口结构的认知,配合类型提示、Mock 能力,大大提升开发体验。...RESTful API 优劣势 RESTful API 是目前最广泛使用的接口规范,基于 HTTP 协议,使用资源路径和请求方法组合完成数据操作。...而且通过 Postman、curl 等工具即可快速测试和验证接口。 但它也存在一些问题: 比如,请求冗余,无法控制字段粒度,常常返回大量用不到的数据!...还有就是扩展性不如 GraphQL,对于需要动态字段、自定义响应结构的场景,REST 显得不够灵活! 最后 GraphQL 和 REST 各有千秋,关键在于选择适合自己团队和项目的方案。

    43710
    领券