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

    创建 REST API 的最佳入门教程

    在这个教程中,我将会诠释REST的基础以及如何给应用创建一个API(包括认证授权)。 ? 什么是API?...API是Application Programming Interface应用编程接口的缩写,它是拿来描述一个类库的特征或是如何去运用它。...id=123 当人们开始去实现他们自己的API接口时,问题就出现了。竟然没有一个标准的方法来命名URL,人们总是要参考API才得知它是如何运作的。...REST是Representational State Transfer的缩写,它是由罗伊·菲尔丁Roy Fielding提出的,是用来描述创建HTTP API的标准方法的,他发现这四种常用的行为(查看...没理由去支持其他的格式,除非你已经有一个可支持的API。 创建一个REST API 事实上,创建一个REST API是超出此教程范围的,因为它是有特定语言的。

    3.6K20

    腾讯会议REST API 用户创建激活策略调整通知

    本次更新点创建用户接口:1、创建后的用户是未激活状态,默认创建用户接口调用后会自动发送激活邀请,您也可以关闭自动发送邀请开关,通过调用发送用户激活邀请接口主动触发激活邀请。...预计更新时间2023年5月11日影响范围API接口创建/激活用户修改方法在调用API“创建用户”接口后新增激活流程处理代码,激活流程如下:步骤1、调用创建用户接口步骤2、24小时之后调用获取用户详情接口检查账号的激活状态...,输出参数status为3(1:正常,2:注销,3:未激活,4:禁用),继续下一步,否则结束本流程步骤3、调用发送用户激活邀请接口重新发送激活短信/邮件,并继续步骤2文档链接创建用户:https://cloud.tencent.com

    2.1K20

    Rest api简介

    下面是一个来自 IBM developerWorks 的 API 样例,尝试请求该 API,你可以看到该集合是如何支持不同的输出格式请求的。 清单 3....常用 HTTP 响应代码含义 HTTP 响应代码 代码含义 200 已创建,请求成功且服务器已创建了新的资源。...使用 HTTP 头进行缓存处理 在 REST 的构架中,我们除了在与后台的数据交换中,需要有一个良好的缓存机制外,针对 REST API 请求都是在远端用 HTTP 发起这一特点,还需要为网络缓存进行更多考虑...你可以考虑在设计 API 的时候允许客户同时创建或者更新多个资源。...文档服务: 是否由于 API 持续更新,使得客户端连接不同版本服务的时候疲于奔命?尝试着把你的 API 定义规范成 XML 文档,这样客户端很容易理解当前服务可以提供哪些功能,以及如何使用这些功能。

    2.9K60

    如何快速创建一个拥有异步任务队列集群的 REST API

    本文分享如何使用 docker-compose、FastAPI、rq 来快速创建一个包含异步任务队列集群的 REST API,后端执行任务的节点可以随意扩展。...用户请求 api, api 将任务放入 redis 队列,worker 自动去 redis 队列取出任务并执行,worker 节点可以任意水平扩展。...API、Worker REST 是一种风格,这里不是重点,我们使用 FastAPI 来快速创建一个接口,新建一个 api.py 的文件,内容如下: from fastapi import FastAPI...创建一个包含依赖的 Python 镜像 现在我们来创建一个包含前文 requirements.txt 依赖的 Python 镜像,编写 Dockerfile,内容如下: FROM python:3.8-...最后的话 本文分享了如何使用 Dockerfile 构建一个镜像,使用 Docker Compose 管理一个容器集群,以此为基础实现了一个具有异步任务队列集群的 REST API,抛砖引玉,关于 Dockerfile

    2.3K30

    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 设计最佳实践:如何构建、设计和使用 API ?

    我见过的大多数API 都“声称” 是 “符合REST原则”的——意味着遵循 REST 架构的原则和约束。...例如:POST: /books/可能意味着“创建一本新书”。...现在问题来了:如何将这样的功能融入REST API? 我的答案是:使用查询字符串(querystring)。 我认为使用查询字符串实现分页非常明显。它看起来像这样: GET: /books?...虽然我还没有创建资源(尚未),但这没问题。 有两个主要场景,我觉得202 Accepted特别适用: 如果资源将在未来处理后被创建 — 例如:在某个工作/流程完成之后。...使用专门针对REST API的网络框架 作为最后一个最佳实践,让我们讨论这个问题:如何在您的API中实际应用最佳实践?大多数时候,您希望建立一个快速的API,以便一些服务可以相互交互。

    2.1K40

    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...这些术语在此上下文下是同义词,但 HTTP 规范了如何使用这些术语的方法。...符合 Microsoft REST API 指南的 API 应该支持 PATCH 方法。

    2.9K50

    Microsoft REST API指南

    Microsoft REST API指南 摘要 Microsoft REST API指南作为一种设计原则,鼓励应用程序开发人员通过RESTful HTTP接口访问资源。...本文档建立了 Microsoft REST API 开发人员应该遵循的指南, 以便统一一致地开发API。...如:实现或必须与某些外部定义的REST API互操作的REST服务必须与哪些外部的API兼容,而无法遵循这些准则。而还有一些服务也可能具有需要特殊性能需求,必须采用其他格式,例如二进制协议。...无论如何,当兼容性被破坏时,该服务应该尝试在下一版本发布时变得合规。 当一个服务添加一个新的API时,该API应该与同一版本的其他API保持一致。...符合Microsoft REST API准则的API应该支持PATCH。 7.4.3.

    6.1K11
    领券