关于RESTful风格接口设计的理解

二十八、Node.js中的RESTful API和接口设计 REST即表述性状态传递(英文:Representational State Transfer,简称REST)是Roy Fielding博士在2000年他的博士论文中提出来的一种软件架构风格。它是一种针对网络应用的设计和开发方式,可以降低开发的复杂性,提高系统的可伸缩性。(引用自百度百科) 阅读详情

RESTful的概念


表现层状态转换(英语:Representational State Transfer,缩写:REST)是Roy Thomas Fielding博士于2000年在他的博士论文[1]中提出来的一种万维网软件架构风格,目的是便于不同软件/程序在网络(例如互联网)中互相传递信息。表现层状态转换是根基于超文本传输协议(HTTP)之上而确定的一组约束和属性,是一种设计提供万维网络服务的软件构建风格。符合或兼容于这种架构风格(简称为 REST 或 RESTful)的网络服务,允许客户端发出以统一资源标识符访问和操作网络资源的请求,而与预先定义好的无状态操作集一致化。因此表现层状态转换提供了在互联网络的计算系统之间,彼此资源可交互使用的协作性质(interoperability)。相对于其它种类的网络服务,例如SOAP服务,则是以本身所定义的操作集,来访问网络上的资源。

老实说,到现在我也不明白,为什么要用这种让人摸不着头脑的翻译。直到最近,在给一个后辈讲解的时候,突然发现以前设计的接口地址是多么的随心所欲,有时变量在问号前,有时候变量在问号后。所以趁现在还有所感悟,记录一下我的心得。


RESTful接口的设计


RESTful接口的表现形式

GET http://api.sample.com/v1/resources?query=<query>

上面是一个接口例子,它可以被分为4个部分:

1. GET部分

该部分表示接口与服务器的交互方法。最常见的有4种:GET、POST、PUT、DELETE,分别对应着查询、新增/插入、修改、删除四种操作。有了这个操作定义之后,我们无需再往path里补充任何动词。

2. http部分

这个部分是传输协议。常见的有HTTP、HTTPS、 FTP等,表示任何物理介质中允许两个或多个在传输系统中的终端之间传播信息的系统标准。这个部分按实际需求选择即可。

3. api.sample.com/v1/resources部分

这个部分我把它称为PATH。具体细分还可以分为2-3个部分:域名、版本号(可选)、资源名。域名就不多说了,版本号在定义里原来是没有的,但加入版本号的好处是可以在不破坏原有流程的基础上进行迭代,使旧流程可以更安全稳定地过渡到新流程中。
接下来我想重点谈谈资源名部分,一般来说这个地方应该是服务名加上数据表名或是文件名,以表示一组资源。它应该是一个不带动词的名词。同时,你也可以带上这个id号,以进一步区分单个资源。
但是在内部开发中,由于需要对同一个资源进行不同的加工,用表名或是文件名作为资源名是远远不够的。故也可以用具体的业务名作为资源名,但仍然要满足它是一个名词的要求。
我遇到一个业务,需要设计获取农批市场肉菜分析图表的接口,这个时候使用/{retail | wholesale}/{meat | vegetable}/{stat | trends}作为资源名也是不错的选择,这种按属性分隔的设计可以很清楚明了地区分各个接口的作用,同时又不会使接口显得杂乱无章。

4. query部分

顾名思义,这个部分用作补充查询条件,表现为跟在?后面,用&把各个参数连接起来。这一部分常用于GET、PUT和DELETE3种交互操作中,起到类似于sql里面的过滤条件作用。当然,query参数也可以作为数据加工的指示条件来使用。

*. 并没有在例子中体现的body部分

这个部分常出现在POST和PUT方法中,作为它们的传参方法。POST有4种常见提交数据方式,RESTful提倡使用application/json作为我们的body提交类型。在设计body的时候,要注明字段的属性如:字段名、是否必传、字段类型、默认值和字段说明等。


一些补充说明

  1. 在设置path、query、body、response变量名时,切记避开一些编程语言关键字如type、in等,不如说在任何时候都要尽量避免使用它们。
  2. 在path中应该使用-替代_,这样才符合url的规范,而query中则要反之。
  3. 在设计多个类似接口时,尽量使它们的用法保持一致。包括query名与作用一致,返回结果的结构一致,相同或近似字段名一致等。这样可以大大减轻双方后期许多的工作量!
高薪程序员&面试题精讲系列144之项目接口如何设计?你熟悉Restful吗?Swagger用过吗?前后端如何交互? 我们在进行后台开发时,Web接口的设计都是后端的工作。但这些接口,并不是我们想怎么写就怎么写的,必须遵循一定的规范。而现在比较流行的Web接口设计规范就是RESTful风格,所以今天壹哥就带各位梳理RESTful风格的Web接口设计内容。当然这些内容,在我们的线下课程中已经有了非常详细地讲解了,如果你还不了解,可以私信壹哥哦。如果面试官问你们的项目是否是前后端分离的,对于这种问题,其实没有标准的固定答案。你要么就实事求是地进行回答,是前后端分离就回答是,否则就回答不是。... 阅读详情

相关推荐

从数据到特征:基于CAT12的MRI图像预处理实战指南

本文详细介绍了使用CAT12工具进行MRI图像预处理的完整实战流程。从数据获取、环境搭建到核心的AC-PC校正、组织分割、空间标准化与调制,逐步解析如何将原始脑影像数据转化为可用于机器学习的标准化特征图。重点阐述了预处理作为脑影像分析‘生命线’的重要性,并提供了避坑指南与自动化脚本建议,帮助研究者构建高质量的阿尔茨海默症分类模型输入特征。

weixin_29065959的博客 311

RestFul接口设计

一、接口编程 1、背景 随着互联网的发展,尤其是移动互联网为代表的Web3.0时代,客户端层出不穷,以APP、微信、PC浏览器为代表,服务端业务逻辑基本一致的,那么有没有一种方式可以做到“服务端一次编写,客户端随时接入”呢 流行的方案就是“接口编程” 2、接口编程 API(Application Programming Interface,应用程序编程接口),程序之间交互数据的一种方式。 以浏览器和服务器之间的数据交互(ajax请求)为例: 请求方式:get方式 post方式 请求协议:http协议 ht

weixin_45730243的博客 6562

ASP.NET Core Identity + Mysql(实战一)——注册登陆

在进行实战之前,我们先来了解一下Identity。 ASP.NET Core Identity是用于构建ASP.NET Core Web应用程序的成员资格系统,包括成员资格、登录和用户数据存储。简单的来讲包括: 1.用户数据存储(使用任意你喜欢的关系型数据库,从sqllite到mysql、sqlserver等等,由Entity Framwork 支持) 2.登陆、注册外加身份认证(基于coo...

weixin_40359716的博客 1400

RESTful接口设计规范

RESTful是目前最流行的API设计规范,它是用于Web数据接口的设计。从字面可以看出,他是Rest式的接口,所以我们先了解下什么是Rest。REST与技术无关,它代表的是一种软件架构风格,REST它是 Representational State Transfer的简称,中文的含义是: “表征状态转移” 或 “表现层状态转化”。它是基于HTTP、URI、XML、JSON等标准和协议,支持轻量级、跨平台、跨语言的架构设计。

浮游的博客 6419

一致性总线CMN600AE-ARM系列

主要介绍一致性总线CMN600AE,根据arm官网的spec来概述其模块。提示:以下是本篇文章正文内容,下面案例可供参考CMN600ae是基于Mesh拓扑结构,对外支持AMBA CHI/ACE-LITE等接口,内部改用路由结构转发数据,并提供硬件一致性和系统缓存,还支持多芯片互联。CMN600在T16FFC上可以做到2Ghz,另外AE版本增加了车轨芯片的安全功能,总线内部采用EDC检查,接口采用的奇校验。

tujiuguo3994的博客 6297

在trae CN中使用conda环境(已解决)

Trae CN 是字节跳动于 2025 年 3 月 3 日发布的国内首个 AI 原生集成开发环境(AI IDE)123。

zwzscnds的博客 6940

RESTful接口

作为一个后端服务端开发者,经常会听到你会开发restful接口吗,可能我开发过?可能我又没有?但其实主要是因为我没有彻底搞懂restful风格接口,今天下午必须整明白!

Estelle的博客 856

Ubuntu终端AI编程助手配置:Claude Code接入DeepSeek模型全攻略

在软件开发领域,AI编程助手正成为提升开发效率的重要工具。其核心原理是通过大语言模型理解自然语言指令,生成、解释或调试代码。这类工具的技术价值在于将AI能力无缝集成到开发工作流中,减少上下文切换,实现更流畅的人机协作。常见的应用场景包括代码生成、错误调试、代码重构和技术问答等。本文聚焦于在Ubuntu系统中,将流行的终端AI助手Claude Code的后端模型从原版Claude替换为DeepSeek。通过配置环境变量实现API端点和模型的映射,这一过程涉及Node.js环境管理、npm包安装和关键环境变量设

weixin_42527654的博客 379

RESTful 接口设计

REST 是 Representational State Transfer 的缩写,如果一个架构符合 REST 原则,就称它为 RESTful 架构。RESTful 架构可以充分的利用 HTTP 协议的各种功能,是 HTTP 协议的最佳实践。RESTful API 是一种软件架构风格、设计风格,可以让软件更加清晰,更简洁,更有层次,可维护性更好。

weixin_44512485的博客 815

【Pix4d精品教程】Pix4d空三后处理:点云分类与过滤、DSM精编生成DEM、生成等高线案例详解

本文详细介绍了利用Pix4D软件进行无人机摄影测量后处理的关键步骤,主要包括点云分类与分配、DEM精编生成和等高线绘制三个核心环节。首先通过点云分类区分地面、植被等7种地物类型,然后通过点云分配将地面点云归并到Ground类别,剔除植被等干扰要素。随后重新运行DSM生成步骤获取精确DEM,最后在附加输出中设置参数生成标准等高线。文中配有详细的操作截图和注意事项,如处理前需备份原始DSM/DOM数据,并解释了DEM与DSM的本质区别。该教程为无人机摄影测量内业处理提供了完整的解决方案。

智慧空间实验室 1万+

华为OD机试2025C卷真题题库目录|机考题库 + 算法考点详解

本文整理华为OD 2025C卷 机试(机考)题库,提供高频考点精析与详细题目内容,提供Java、C++、Python、Go、JavaScript源码实现,并提供完整思路讲解

qq_45776114的博客 3993

什么是Restful风格接口?

1.定义:Restful风格的API是一种软件架构风格,设计风格而不是标准,只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。 明确:他只是种代码风格的约束,而不是说非要这样干。 2.各个种类Mapping的作用: GetMapping (SELECT):从服务器查询,可以在服务器通过请求的参数区分查询的方式。 POST(CREATE):在服务器新建一个资源,调用insert操作。 PUT(UPDATE):在服务器更新资源,调用update操作。 PA...

zheng2780071070的博客 7474

YOLOv8【第四章:注意力机制篇·第20节】一文讲透,注意力机制设计原则与选择指南 - 从原理到实践的系统化方法论!

🏆 本文收录于 《YOLOv8实战:从入门到深度优化》,该专栏持续复现网络上各种热门内容(全网YOLO改进最全最新的专栏,质量分97分+,全网顶流),改进内容支持(分类、检测、分割、追踪、关键点、OBB检测)。且专栏会随订阅人数上升而涨价(毕竟不断更新),当前性价比极高,有一定的参考&学习价值,部分内容会基于现有的国内外顶尖人工智能AIGC等AI大模型技术总结改进而来,嘎嘎硬核。    ✨ 特惠福利:目前活动一折秒杀价!一次订阅,永久免费,所有后续更新内容均免费阅读!

**My Coding Family** 899

restful接口设计风格简单理解

restful是目前最流行之一的api接口设计风格,主要有以下特点 1、资源 2、统一的接口url 3、无状态 总的一句话,restful是一种接口设计风格,没有很固定的限制,只要满足条件,都算restful 它通过一个唯一并且统一的接口url,根据不同的method POST/DELETE/PUT/GET来分别对应一个资源的增删改查操作。 详情可查看中文网 http://restful.p2h...

qq_30966497的博客 772

贝叶斯统计 [韦来生编]

贝叶斯(Bayes)统计是近几十年来迅速发展起来的数理统计的一个重要分支。贝叶斯方法与经典统计方法的主要不同之处是进行统计推断时除了利用样本信息外,还要利用参数的先验信息,因此可以提高统计推断或统计决策的效果。它在经济、金融、生物、医学、自然科学和社会科学等许多领域具有广泛的应用。贝叶斯方法的研究已渗透到了统计学的几乎所有领域。作者在给中国科学技术大学概率论与数理统计专业本科生开设的“数理统计”课程中有一章专门讲授“贝叶斯方法和统计决策理论”,近十年来也给中国科学技术大学概率统计专业研究生开设过几次“贝叶斯分析”课。本书是在对过去讲稿的内容作了适当的增减和调整的基础上完成的。  本书共分六章。第1章是绪论,介绍了贝叶斯统计的若干基本概念,同时对必要的数理统计的基础知识有重点地作了回顾。第二章介绍了确定先验分布的若干可供选择的方法。第三章介绍了几类常见统计模型参数的后验分布的主要结果和计算方法。第四章和第五章分别介绍了“贝叶斯统计推断”和“贝叶斯统计决策”的内容。第六章介绍了贝叶斯统计计算的若干方法,包括蒙特卡洛方法和马尔可夫链蒙特卡洛(MCMC)方法以及相关统计软件的简介。本书的每一章附右大量的例题和习题,书末附有常用的几个表格和部分习题解答供读者查用。  大约可在54学时内讲授本书的第1章至第六章的主要内容,教师可根据学时需要选讲本书第1章至第六章的部分内容。书中标“*”号的章节可略去不讲,留给读者作为阅读材料。第六章例题中的R代码和部分例题的数据文件等可从作者个人主页下载。  作者在编写本书的过程中参考了J.O.Berger教授的《统计决策论及贝叶斯分析》和茆诗松教授编写的《贝叶斯统计》等书中的一些内容,以及《贝叶斯分析》一书中由张伟平博士编写的有关贝叶斯统计计算的一些内容。在此表示衷心感谢。  本书编写准备过程中,中国科学技术大学统计与金融系的几个研究生帮助完成了本书部分中文的录入和排版,作者对他们的辛勤工作表示真诚的感谢。高等教育出版社为本书的出版给予了大力支持。在此一并致谢。

Camera2Demo

在Camera2 的基础上进行封装,使得Camera2一堆初始化逻辑与Activity分离,降低耦合度,完成预览拍照并保存的操作

RESTful风格的接口命名规范

最近实习单位的leader要求我调研一下RESTful风格的接口命名规范,然后把项目里的URL名整体规范化修改一下,以下是我的对于RESTful的了解。 REST是一个术语的缩写,REpresentational State Transfer,中文直译是“表征状态转移”。 REST是一套风格约定,RESTful是它的形容词形式。比如一套实现了REST风格的接口,可以称之为RESTful接口。 目前...

杨杨杨的博客 5万+

怀旧版电脑GBC模拟器

再现原版GBC掌机的界面,电脑运行连游戏界面都一样大小,很怀旧,很真实,(英文版)强烈推荐,很小的文件,很难才找到的。

浅谈RESTful风格下的API接口设计

前言 百度百科 RESTFUL是一种网络应用程序的设计风格和开发方式,基于HTTP,可以使用XML格式定义或JSON格式定义。 RESTFUL适用于移动互联网厂商作为业务使能接口的场景,实现第三方OTT调用移动网络资源的功能,动作类型为新增、变更、删除所调用资源。 理解 RESTful是一套通俗的约定和标准, 是协议通信的双方共同遵守的约定. REST架构的核心便是REST : Representational State Transfer Resources (资源) URI是每个资源地址的独一无

即知江湖 709

TMS_WebGMaps_1.9.8.0_Full_Source

TMS_WebGMaps_1.9.8.0_Full_Source 全源码 delphi cbuilder

一文了解什么是RESTful风格

RESTful风格是一种软件架构风格,它是一种设计网络应用程序的方式,可以使系统更加简单、灵活、可扩展和易于维护。RESTful是Representational State Transfer的缩写,它强调使用标准的HTTP方法(如GET、POST、PUT、DELETE)来对资源进行操作,通过URL来定位资源,并使用状态码来表示操作结果。

Wzill 1657

Java开发RESTful

一.首先,什么是REST?  REST从字面上讲叫做Representational State Transfer,翻译成表现层状态转移,但是一般在翻译的时候,前面会加一个Resource,即Resource Representational State Transfer,即为资源表现层状态转移.用人话讲就是:客户端通过HTTP请求,对服务器端的资源进行操作,实现"表现层(使用HTTP动词去促使

fly_zhyu的博客 1万+

一文搞懂RESTFUL风格(Java版)

restful的风格其实是一种规范,用来规范我们在写接口时的命名,用于前端与后端、项目与项目之间来传递数据。restful可以使我们的接口更加简洁、快捷高效、透明。为了不同的前端和后端进行信息交互,Resultful API是一种比较流行的一种API规范。结构清晰符合标准,易于理解、扩展方便,便于前端开发者进行区分访问接口资源。 Restfule风格是一种软件架构风格,而不是标准,只是提供了一种设计原则和约束条件。Get 获取资源Put 更新资源Patch 更新部分属性Delete 删除资源Post 创

qq_42429369的博客 7150

RestFul风格传参

RestFul风格就是所有参数都由/传递,而不是传统的?xx&xx形式 例如:写一个Controller: package controller; import org.springframework.stereotype.Controller; import org.springframework.ui.Model; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.we

weixin_44976835的博客 6788

Spring Boot系列之三 RESTful风格API

Spring Boot系列之三 RESTful风格API

qq_43741569的博客 230

REST,以及RESTful的讲解

<div class="blog-content-box"> <div class="article-header-box"> <div class="article-header"> <div class="article-title-box"> <span cl...

467

如何设计一个优雅的RESTFUL的接口

推荐阅读: 阿里二面凉经:设计模式+缓存+Spring+虚拟机+MySQL+中间件+并发等难题,全部迎刃而解 阿里巴巴字节跳动那些大厂必问的HTTP该怎么学?我建议你看看这篇文章! 蚂蚁、字节、PDD社招面经Java岗(分布式+线程安全+MySQL+CAS) 一 、引入 设计接口是我们开发人员的日常操作。当我们把接口交给前端人员时,是否有种拔剑出鞘的错觉。毕竟交付接口,我们的开发工作就阶段性完成了。不过,如果我们没有一个接口设计规范的时候,结果会怎样呢?我们来张图感受一下。 二、REST 2000年,

m0_57541165的博客 245

RESTful(REST风格)是什么?(Java学习笔记)

RESTful:什么是REST,其标准是什么?

m0_59803718的博客 496

RESTful 详解介绍

本文版权归作者所有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接出处:https://blog.youkuaiyun.com/qq_3076499,否则保留追究法律责任的权利。 如果文中有什么错误,欢迎指出。以免更多的人被误导。如果对您有帮助 ,请多多支持.RESTful一种软件架构风格、设计风格,而不是标准,只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件...

从放弃到开始 818

什么是RESTful接口风格?

RESTful接口风格通过使用HTTP协议的标准方法(如GET、POST、PUT、DELETE)来操作资源,强调无状态、资源导向和统一接口等特性,使得API设计简洁、易理解并且具有高度的可扩展性。

// 1660
上一篇: 关于django makemigrations/migrate在生成数据表上遇到的一些问题
下一篇: 为什么python在urlencode空格的时候会被编码成“20”而不是“+”?
调皮博士
博客等级 码龄10年 14粉丝 15原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值