异步 API 的设计

小郝不负流年
小郝不负流年   + 关注
2021-02-25 12:12:47   阅读5   评论0

网站的前后端通信,往往会有异步请求,这时应该怎么设计 API? 

一、同步 API

为了便于比较,先看看同步 API 的设计。下面是一个很简单的例子。

客户端发出一个请求,要求创建资源。

POST https://api.service.io/stars
name='Death Star' 

服务器回应 201。

HTTP/1.1 201 Created
Location: /stars/12345

201 Created告诉客户端,请求成功,资源已经创建。新的资源的网址请看Location字段。

二、异步请求

如果服务器不能立即返回结果,就形成了异步操作。

客户端的请求还是一样的。

POST https://api.service.io/stars
name='Death Star' 

服务器回应 202。

HTTP/1.1 202 Accepted
Location: /queue/12345

202 Accepted告诉客户端,请求已经接受,但还没有处理,可以去Location字段查询进展。

除了上面的头信息,服务器的回应如果有数据体,可以返回一些有效信息(比如任务完成的估计时间、当前状态等等)。

三、查询进展

过了一段时间,客户端就发出请求,查询异步处理的进展。

GET https://api.service.io/queue/12345 

服务器回应 200。

HTTP/1.1 200 Ok  


 PENDING
  2 mins.
   

200 Ok告诉客户端,请求成功,具体情况查看数据体。数据体里给出提示,异步操作已成功或还需要等待。

四、异步操作成功

有一种特殊情况,用户查询异步操作的进展的时候,可能会希望,如果异步操作已经完成,就直接跳转到新资源。

这时,服务器回应 303。

HTTP/1.1 303 See Other 
Location: /stars/97865

303 see other告诉客户端,重定向到不同的资源。Location字段就是跳转的目标,也就是新资源的网址。

五、删除查询链接

一旦异步操作完成,客户端可以要求服务器删除查询链接。

DELETE https://api.service.io/queue/12345 

服务器回应 204。

HTTP/1.1 204 No Content

204 No Content告诉客户端,删除成功。以后,客户端再访问这个查询链接,服务器回应404 Not Found。

如果客户端不删除查询链接,服务器完成异步任务后,也可以自动删除。客户端再请求这个链接,服务器回应410 Gone,表示该链接永久性不再可用。

文章来源:http://www.ruanyifeng.com/blog/2018/12/async-api-design.html
对我有用,我要     转载  
文章分类: 设计思想/开发模式  
所属标签: 异步API  
  • 0条评论
  • 只看作者
  • 按时间|按热度
  • 由于本人多次涉及需要打印这个证明,而每次都会忘记入口,在网上各种搜索各种摸索很是浪费时间。故本次将操作流程整理记录下来,以备忘。同时也分享给大家。1、打开湖北政务服务网,地址:http://zwfw.hubei.gov.cn/s/index.html2、切换区域到“武汉市”3、在“特色服务”模块找到“(个人)武汉市社会保险公共服务平台”4、进入“(个人)武汉市社会保险公共服务平台”,登录账号密码<imgsrc="https://cdnstatic.hoscen.cn/blog/article/184053017752895488/img/497065960be44747825acb86a17483c1.png"style=
  • 目录:1、安装node.js环境2、安装cnpm3、安装vue-cli脚手架构建工具4、用vue-cli构建项目5、安装项目所需的依赖6、项目运行7、项目打包1、安装node.js环境下载地址:https://nodejs.org/zh-cn/安装过程没有太多好说的,安装完成后 win+R打开命令行输入node -v , 如图,出现版本号说明安装成功。npm包管理器是集成在node中的 , npm -v可以查看版本2、安装cnpm由于有些npm有些资源被屏蔽或者是国外资源的原因,经常会导致用npm安装依赖包的时
  • 1、找到nginx安装目录,找到nginx.conf ,  vi nginx.conf2、在http模块下面添加 server_tokens off;  ##隐藏版本号http {     ... 此处省略          server_tokens off;  ##隐藏版本号          ... 此处省略 }3、重启nginx4、效果如图,看不到版本号了
  • Thumbnailator,一个google开源的优秀的工具类 。根据提供的API可以快速实现图片缩放,区域裁剪,水印,旋转,保持比例 等操作。Thumbnailator官网:http://code.google.com/p/thumbnailator/ 本文主要讲图片原比例压缩功能。1、引入maven依赖2、demo测试public class TestImageUtil { public static void main(String[] args) throws IOException { String originImgPath = "C:UsersHoscenDesktopit.png"; String destImgPath = "C:UsersHoscenDesktopit-30.jpg"; Thumbnails.of(originImgPath) .scale(1f) .outputQuality(0.3f) .outputFormat("jpg") .toFile(destImgPath); } }3、测试结果原图,大小82.5kb<img src="https://static.hoscen.cn/blog/article/191329330033328128/img/5fa848b2b8f449bdb05dd78771777f83.png" style="width: 600px;" class="fr-fic fr-dib fr-fil
  • 公益 404 页面介绍公益404页面是由腾讯公司员工志愿者自主发起的互联网公益活动。网站只需要在自己的404页面中嵌入一段简单的代码,就能通过互联网来迅速传播失踪儿童信息,从而提高找回失踪儿童的概率。失踪儿童信息来自宝贝回家寻子网。公益 404 页面接入方法:复制以下 js 代码,嵌入到您的 404 页面,可以自适应移动设备。<script type="text/javascript" src="//qzonestyle.gtimg.cn/qzone/hybrid/app/404/search_children.js" charset="utf-8"         homePageUrl="https://www.hoscen.cn/" homePageName="回到首页"></script>效果展示:注意事项:如果一个 404 页面的内容小于 512B,IE 会认为该 404 页面不够友好,在 IE 下将不会成功返回该 404 错误页面
  • 一般我们在使用CDN时都设置有缓存时间,当源站资源发生变更后,如果缓存时间没到,那么用户访问的依旧是变更前的数据,虽说又拍云控制台提供了缓存刷新功能界面,但是每次都手动去刷新显示不太理想,当然又拍云也想到了这一点,提供给我们有API可以调用。本篇文章就是讲解如何接入又拍云缓存刷新API。网站免费接入又拍云CDN的方法,请查看我另外一篇文章,地址: https://www.hoscen.cn/blog/hao/articles/204022774975430656.html又拍云API文档:https://api.upyun.com/doc#/api/guide/overview看完文档,我们会知道又拍云提供有两个缓存刷新接口,一个支持通配符(但次数有限),一个是完整url刷新。同时注意调用接口时将 Token 放入 HTTP Header 中 。那么我们需要3个接口:1、获取token2、URL刷新3、缓存批量刷新详细请求参数和响应值请查看文档。话不多说,我们直接放上核心代码1、获取token2、URL刷新<img src="https://cdnstatic.hoscen.cn/blog/article/
  • 分享一个jQuery插件textarearesizer。它提供Resizer bar可拖动调整Textarea/div大小。代码示例:代码下载:    点击此处效果图:
  • 前言:大部分前端开发Vue用的工具是vscode 或webstorm , 但是作为后端开发习惯了使用idea, 当然开发Vue也要用idea啦。前面已经讲到了《Vue入门篇:(一)环境搭建、项目创建、项目运行、项目打包》, 接下来就讲在idea开发vue项目的环境配置。配置过程:1、打开Setting > Plugins , 搜索vue.js插件并安装。2、打开Setting >Editor >  File Types , 配置HTML文件类型支持 .vue后缀3、打开Setting > Lnaguages .. > JavaScript  , 配置ES64、打开Terminal,执行npm r
  • XMind思维导图是做什么的,怎么使用,这些问题不在本次说明范围,本次就只做分享,一个XMind2020绿色免安装版分享!特点:1、无需安装,解压即用;2、可导出所有格式,不受限制;3、导出无水印;链接:https://pan.baidu.com/s/1jT0oXQS0Vxelsx1S2qVlRg 提取码:uew3 如果下载地址失效请留言反馈。资源来源朋友分享,仅供学习参考使用,请在下载后24小时内删除,请支持正版。
  • 1真爱应该被定位为:温柔且有耐心的帮助对方成为更好的人。2不管身处怎样寒冷的冬季,只要想到你,心里就会不禁的温暖四起。3让我们每天带着希望出门,如果事与愿违,就再把希望带回家,休息休息,明天继续带出门。4我也太孤单了吧,连个偏旁部首都没有。5人间星火,竟无半点属于我。6如果总想着以后会遇到更好的人,那我们的相遇就毫无意义。7喜欢是晨曦前的朝露,喜欢是清风拂过山间,喜欢是想要触碰却收回的双手。8世间一切皆可努力,唯独相爱全凭运气。