RSET可以降低开发的复杂度,提高系统的可伸缩性,增强系统的可扩展性,简化系统之间的集成,因为得到广大开发人员的喜爱,也得到业界广泛的支持。
使用 POST 方法在服务器上创建资源
使用 PUT 方法对服务器的现有资源进行更新
使用 DELETE 方法删除服务器的某个资源
从一下几点来讨论rest api 设计
一 规划 资源表示结构 和 URL模式
1获取一个简单实体样例
REST API 请求: GET http://example.com/航班信息/CA827/entry
2 用feed 表示集合类型
3 url使用过滤条件,样例 / 环境工程系 / 学生 ?filter=age between (15, 18)
4 排序来帮助客户端更好的展现数据 样例 ?sortOrder=asc&sortField=age
5 分页展示数据 startIndex=27&count=22
二 根据应用场景提供内容协商
1 URL参数 进行内容协商 如,format=xml,format=json 协议版本
2 使用accept头对内容进行协商
通常使用 Accept 来设置我们接受的返回结果的内容格式,用 Accept-Charset 来设置字符集,用 Accept-Encoding 来设置数据传输格式,用 Accept-Language 来设置语言
3 用url 模式 航班号 /json 来返回 JSON 格式的结果
三 正确使用http相应代码
四 处理缓存和并发
缓存控制:
缓存控制通常是需要客户端,缓存服务器 / 代理服务器与业务服务器一起发生作用。
HTTP 头中有“Cache-control”字段来控制如何使用缓存,常见的取值有 private、no-cache、max-age、must-revalidate 等。比如当你给返回的数据内容设置 max-age=600,那么当用户隔了 30 秒再次请求的时候,就不会导致重新请求后台数据。
另外,也可以通过“Expires”字段来指定内容过期时间,在此时间前的请求都不会导致后台程序重新请求数据。
条件请求与电子标签:
很多时候,数据内容可能会几个小时甚至几天都不会发生变动,这个时候根据请求时间间隔来控制缓存,就不能满足系统的需求了。通过支持条件请求与电子标签,可以帮助我们来解决这个问题。
当用户请求数据内容时,系统在返回数据的同时,在 HTTP 头中,将返回根据服务器内容的最后修改时间 Last-Modified,或者根据服务器内容生成电子标签 ETag。 当用户再次请求数据时,就可以在 HTTP 请求中使用 If-Modified-Since 或者 If-None-Match 头信息,把上次请求得到的时间戳或者电子标签传给服务器。当收到一个有条件请求的 HTTP 头的 REST 请求的时候,我们的程序需要将收到的时间戳或者电子标签与当前内容作比较,就可以很容易的知道用户请求的数据内容在这段时间是否发生过修改,并根据比较结果返回给用户最新内容,或者用 HTTP 响应码 304 告知用户,内容没有变化。
并发处理:
通过在写操作中支持条件请求,我们可以更好的处理并发修改。用户在发出修改请求的同时,在 HTTP 请求中使用 If-Not-Modified-Since 或者 If-Match 头信息,把获取数据时得到的时间戳或者电子标签传给服务器;我们的程序通过与服务器当前内容的比较,就可以知道,这个修改请求是否是针对当前内容提出的。当服务器发现内容已经被其他用户修改过了,就不会执行修改请求,并返回 HTTP 响应码 412(未满足前提条件)给用户。
五 利用数据冗余和链接元素
数据结构中提供 其他api url 连控制冗余数据
其他技巧
批量更新:
当用户需要更新多个资源的时候,你打算让开发者一次次的发送 HTTP 请求逐个更新吗?你可以考虑在设计 API 的时候允许客户同时创建或者更新多个资源。
REST 安全:
除了使用固有的 HTTP 基本验证,你还可以考虑通过支持表单验证,LTPA 验证,Open ID 验证等方式,来满足更多的企业安全要求。
文档服务:
是否由于 API 持续更新,使得客户端连接不同版本服务的时候疲于奔命?尝试着把你的 API 定义规范成 XML 文档,这样客户端很容易理解当前服务可以提供哪些功能,以及如何使用这些功能。
分享到:
相关推荐
在本系列中,学习如何以REST API的形式运行和执行Jupyter Notebook。 我们如何将Jupyter Notebook作为Rest API运行? 这是我想解决的问题,目的是学习Jupyter笔记本对于各种背景的程序员的功能如何。 原因:自动化。...
API 网关是一个处于应用程序或服务(提供 REST API 接口服务)之前的系统,用来管理授权、访问控制和流量限制等,这样 REST API 接口服务就被 API 网关保护起来,对所有的调用者透明。因此,隐藏在 API 网关后面的...
elastic-thought, 用于Caffe深度学习框架的可以扩展 REST API Caffe 深入学习框架的可以扩展 REST API 包装。问题Caffe是一个非常深的学习框架,但是在一台笔记本电脑或者台式计算机上运行它并不像在云中运行它那样...
描述信息: http://blog.csdn.net/genfeng/article/details/31098021 RESTful学习笔记
ceph-mgr rest api学习笔记
mJupyter-笔记本基于Jupyter Notebook实现的最小REST api体系结构。 注意:这仅出于学习目的。怎么跑python app.py要求烧瓶- pip install flask
RESTfulAPI 根据杨旭老师的教程 ,采用.net5.0构建RESTful API,记录学习过程。
高效管理工具是一款专门为知识管理和个人效率提升而打造的工具,TidGi(太记) 高效管理工具能够很好的保护用户的隐私习惯,还有很棒的高级自动化管理,同时提供与Anki等应用REST API连接,能够给个人学习和团队提供...
Master节点负责整个集群的控制和管理,所有的控制命令都是发给它,上面运行着一组关键进程:kube-apiserver:提供了HTTPREST接口,是k8s所有资源增删改查等操作的唯一入口,也是集群控制的入口。 kube-contr
springboot学习笔记 spring基础 Spring概述 Spring的简史 xml配置 注解配置 java配置 Spring概述 Spring的模块 核心容器CoreContainer Spring-Core Spring-Beans ...
软件测试基础翻译——原网站地址:Software Testing Fundamentals ... Unittest 单元测试框架 Robot Framework 关键字测试框架 ...UI自动化测试 Selenium + Python 学习笔记 Client 端测试记录 其它测试心得总结
该存储库包含使用Fast API构建的REST API,该服务用于模型和 ,以从上传的MP3文件中提取功能。 现场演示 Web应用程序: : 相关资料库 后端-REST API: : 项目笔记本: : 发展 对于此项目,建议使用yarn来管理...
这是一个简单的Rest API,使用Express和SQLite创建,以帮助那些学习前端技术的人,例如: Vue, React 角度的 用法 确保已安装Node 。 (它是使用v14.16.0创建的) 克隆存储库 打开终端或CMD 导航到根文件夹 ...
这将是对机器人技术,云计算,机器学习,HTTP REST API,IoT和许多其他有趣的通用软件工程概念和算法的精彩介绍。笔记尽管有足够的文档,但我将继续完善它并添加更多内容。介绍RoboRover项目结构RoboRover分为3部分...
API设计 REST /超媒体 使用这些原理和元素进行设计: : 研究其他人,寻找与现有媒体类型的自然匹配 有学习/教育形式吗? 安全 目前为私人身份验证,但类似于OAuth,可为将来的平稳发展 不记名代币 签名? 令牌将...
这是一个纯基于Node js的note应用程序rest api构建,未使用任何快速框架。 该应用程序连接到Atlas上的mongo db数据库 新笔记创建的邮递员屏幕截图 列出所有笔记的邮递员屏幕截图 邮递员按ID读取单个笔记的屏幕截图 ...
由 丸子小程序团队 基于 WordPress REST 创建小程序应用 API 数据接口。免费开源,实现 WordPress 连接小程序应用数据。 项目地址: 此小程序为第三方开源小程序,丸子小程序团队出品,代码仅开源提供学习交流。 ...
Web 应用程序、表达为 REST API 和用于存储的 mongodb 的方法。 服务器于 2015 年更新为使用 express 4。此版本还使用 angular 代替主干。所有版本原始概述厌倦了通过电子邮件向自己发送简短的笔记或链接,一旦您...
但一晃好多年没写过后端,代码这东西最怕手生,所以当作重新学习了,顺便写个学习笔记。 Spring Boot是什么? 还恍惚记得当初写Spring的时候要配置好多xml(在当时还是相对先进的模式),虽然实现了松耦合,但这些...