笔记——asp.net core 中的 REST

REST(reprentational state transfer,表层状态转移)

REST原则:提倡按照HTTP的语义使用HTTP。

如果一个系统符合REST原则,我们就说这个系统是Restful风格的。


        在RPC风格的Web API系统中,我们把服务端的代码当成方法去调用而不用关心HTTP谓词的语义。

        即URL中,包含以名词形式描述的资源和一动词形式描述的动作,如:/Person/GetAll、/Person/GetById?id=5、/Person/AddNew、/Person/Update。

        在REST风格的Web API系统中,每个Controller都是对一类资源的操作的集合,每个操作方法都被不同的HTTP谓词出发。

        即URL在的单词都是名词,动作通过HTTP谓词来表述。 


补充:

1、Web API开发有两者风格:

  • 面向过程的(简称RPC,是业务驱动的产物,更加自然);
  • 面向REST的(简称REST,要求开发人员对REST原则更了解,熟悉业务知识,并且有更高的设计能力)

2、HTTP的设计哲学包括:

(1)在HTTP中,我们通过URL进行资源的定位;

(2)在HTTP中,不同的请求方法(又被称为请求谓词)有不同的含义。

        主要的谓词有:GET、POST、PUT、DELETE、PATCH、OPTIONS等 

         不同谓词有不同的用途:
        获取资源用 GET、新增资源用 POST、整体更新(如果不存在则创建)资源用 PUT、删除资源用 DELETE。我们不应该错误地使用谓词,比如删除一个资源的时候,我们不能使用 GET 请求,而应该使用 DELETE 请求。

(3)在HTTP中,DELETE、PUT、GET请求应该是幂等的,而POST则不是幂等的。

幂等:对于一个接口采用同样的参数请求一次和请求多测的结果是一致的,不会因为多次氢气而产生副作用。

(4)在HTTP中,GET请求的响应是可用被缓存的,而DELETE、PUT、POST请求的响应是不可以被缓存的。客户端、网关等可以根据情况对 GET 请求的响应进行缓存,从而提升性能。

(5)在HTTP中,服务端要通过状态码来反映资源获取的结果。

3、服务端传递参数的三种方式:

(1)URL,更符合Restful规范,但不适合传递内容太长或传递参数太多

(2)QueryString,比较灵活但不适合传递太长的内容

  (3)请求报文体,不限制参数内容长度,且可通过JSON产地复杂的格式,但只有POST、PUT支持请求报文体,不支持或忽略GET、DELETE中的报文体。

4、在REST中,传递参数的三种方式的意义不同

(1)URL传递的参数主要用于对资源进行定位

(2)QueryString用来传递额外的数据,比如分页的页码等信息

(3)请求报文体应该用来供PUT和POST提交主要数据,报文体数据以JSON字符串形式进行传递。

        因为开发人员与设计人员对REST的理解程度不同,如果要求系统严格要求执行Restful风格,会导致传递方式混乱。因此建议为项目张参数传递方式指定一个强制性、容易理解、容易实施的标准。

        所以通常我们都是:

        对于保存、更新类的请求一般都是使用 POST、PUT 请求,把全部参数都放到请求报文体中;

        对于 DELETE 请求,要传递的参数就是一个资源的 ID,因此把参数放到 QueryString 中即可;

        对于 GET 请求,一般参数的内容都不会太长,因此统一通过 QueryString 传递参数就可以;当然对于极少数参数内容超过 URL限制的请求,由于 GET、PUT 请求都是幂等的,因此把请求改成通过 PUT 请求,然后通过报文体来传递参数。

5、微软为Web API提供的模板代码、示例代码大部分都严格遵守Restful风格。如果把它们改造为RPC风格,需要做如下操作:

(1)控制器上添加的[Route("[controller]")]修改为[Route("[controller]/[action]")],这样就会匹配控制器的名字,而[action]就会匹配操作方法的名字。

(2)通过不同的路由配置,Asp.NET Core中的控制器可以支持多个同名的重载操作方法,但是匹配不当会导致开发人员认为一个URL请求应该调用A1方法,但是却调用了A2方法。因此,我们强制要求控制器中不同的操作用不同发方法名

(3)把[HttpGet]、[HttpPost]、[HttpDelete]、[HttpPut]这些 Attribute 添加到对应的操作方法上。这不仅会帮助接口开发人员明确操作方法接收的请求类型,更能帮助 Swagger+OpenAPI
生成文档。
        注意
        在 ASP.NET Core Web API中,如果控制器中存在一个没有添加[HttpGet]、[HttpPost]等的 public 方法,Swagger 就会报错“Failed to load API definition.”  

        对于这样的方法,请把[ApiExplorerSettings(IgnorApi=true)]添加到方法上,从而告知Swagger忽略这个方法。


本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/676654.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

文心一言 VS 讯飞星火 VS chatgpt (197)-- 算法导论14.3 5题

五、用go语言,对区间树 T 和一个区间 i ,请修改有关区间树的过程来支持新的操作 INTERVALSEARCH-EXACTLY(T,i) ,它返回一个指向 T 中结点 x 的指针,使得 x.int. lowi.low 且 x.int.high i.high ;或者,如果…

cool 框架 node 后端封装三方Api post请求函数

1.需求 现在一些数据源 ,需要从三方地址拿到一些数据 比如说电影列表 信息了 影院列表信息了 等一些展示的数据,但是人家这种东西 害需要使用 appkey appserect 这种验签 这种需求 你前端调用接口是直接调用不了的 因为需要用到验签 需要后端接口转接一…

爱奇艺图片格式演进

01 背景 图片是爱奇艺APP页面的主要视觉元素,对整体用户体验有着至关重要的影响。同时,由大量启动带来的图片CDN峰值带宽成本也有待降低。因此,在努力提升用户体验的同时,优化图片CDN峰值带宽成本已成为一项关键任务。而决定图片显…

【机器学习】Kmeans如何选择k值

确定 K 值是 K-means 聚类分析的一个重要步骤。不同的 K 值可能会产生不同的聚类结果,因此选择合适的 K 值非常重要。 以下是一些常见的方法来选择 K 值: 手肘法:该方法基于绘制聚类内误差平方和(SSE)与 K 值之间的关系图。随着 K 值的增加,SSE会逐渐降低,但降低幅度逐…

研究多态恶意软件,探讨网络安全与AI

前言 近期ChatGPT火遍全球,AI技术被应用到了全球各行各业当中,国内外各大厂商也开始推出自己的ChatGPT,笔者所在公司在前段时间也推出了自研的安全GPT,AI技术在网络安全行业得到了很多的应用,不管是网络安全研究人员、…

ElasticSearch之倒排索引

写在前面 本文看下es的倒排索引相关内容。 1:正排索引和倒排索引 正排索引就是通过文档id找文档内容,而倒排索引就是通过文档内容找文档id,如下图: 2:倒排索引原理 假定我们有如下的数据: 为了建立倒…

Matlab绘图经典代码大全:条形图、极坐标图、玫瑰图、填充图、饼状图、三维网格云图、等高线图、透视图、消隐图、投影图、三维曲线图、函数图、彗星图

学会 MATLAB 中的绘图命令对初学者来说具有重要意义,主要体现在以下几个方面: 1. 数据可视化。绘图命令是 MATLAB 中最基本也是最重要的功能之一,它可以帮助初学者将数据可视化,更直观地理解数据的分布、变化规律和趋势。通过绘制图表,可以快速了解数据的特征,从而为后续…

?你咋知道我的电脑密码的?---> Mimikatz!

还记得昨天在内网中提到了mimikatz这个工具,那么今天就来和大家讲一下这一款牛逼的工具 但是在这里先祝自己和各位看官新年快乐,万事顺遂 🐉🐲🐲🐲🐲 1.Mimikatz的介绍 传说呢,是…

学习通考试怎么搜题找答案? #学习方法#微信#其他

大学生必备的做题、搜题神器,收录上万本教材辅助书籍,像什么高数、物理、计算机、外语等都有,资源十分丰富。 1.菜鸟教程 菜鸟教程是一个完全免费的编程学习软件。 它免费提供了HTML / CSS 、JavaScript 、服务端、移动端、XML 教程、http…

开发JSP应用程序

开发JSP应用程序 问题陈述 TecknoSoft Pvt Ltd.公司的首席技术官(CTO)John Barrett将创建一个应用程序的任务委托给了开发团队,该应用程序应在客户访问其账户详细信息前验证其客户ID和密码。客户ID应是数字形式。John希望如果所输入的客户ID或密码不正确,应向客户显示错误…

Stable Diffusion 模型下载:Disney Pixar Cartoon Type A(迪士尼皮克斯动画片A类)

文章目录 模型介绍生成案例案例一案例二案例三案例四案例五案例六案例七案例八案例九案例十 下载地址 模型介绍 目前还没有一个好的皮克斯迪士尼风格的卡通模型,所以我决定自己制作一个。这是将皮克斯风格模型与我自己的Loras合并在一起,创建一个通用的…

endnotesX9 如何批量导入 .enw文件

文章是用schoolar搜出来 点击下载引用之后,endnotesX9只能一个一个从.enw文件导入,麻烦 —————————————— 可以在schoolar保存到个人图书馆 类似于上面这种,我用的是保存,保存很多的论文之后点我的个人图书馆&#x…

MySQL进阶查询篇(6)-锁的种类与应用场景

MySQL是一个常用的关系型数据库管理系统。在多用户并发访问数据库时,为了确保数据的一致性和完整性,MySQL提供了多种锁机制。本文将介绍MySQL数据库中的锁的种类与应用场景。 1.悲观锁(Pessimistic Lock) 悲观锁是在进行数据读取…

【GO语言卵细胞级别教程】03.条件与循环语句

注意:以下演示所用的项目,在第一章节已经介绍了,这里不做赘述 目录: 【GO语言卵细胞级别教程】03.条件与循环语句1.条件语句1.1 if语句1.1.1 单层if语句1.1.2 if-else语句1.1.3 if-else-if 语句1.1.4 if 嵌套 1.2 switch 语句1.1…

Android java基础知识

一.Android java基础知识 第一个java程序Hello Worid: public class Hello {public static void main(String args[]) {System.out.println("Hello, world!");} }运行结果: rootubuntu:/home/topeet/guyilian# javac Hello.java rootubuntu…

使用CICFlowMeter 实现对pcap文件的特征提取【教程】

使用CICFlowMeter 实现对pcap文件的特征提取【教程】 针对现有的关于CICFlowMeter 的使用教程不够全面,一些细节没有展示,我将结合网络上的相关资料和实际的经历,提供一些经验和建议。 configuration information --------------- Windows…

C++入门学习(二十六)for循环

for (初始化; 条件; 递增/递减) { // 代码块 } 打印1~10&#xff1a; #include <iostream> using namespace std; int main() { for (int i 1; i < 10; i) { cout <<i<<endl; } return 0; } 打印九九乘法表&#xff1a; #include <iostream…

Java面向对象 访问控制权限

目录 访问控制权限继承多态组合代理向上转型staticfinal 访问控制权限 访问控制权限⼜称为封装 &#xff0c;它是⾯向对象三⼤特性中的⼀种&#xff0c;我之前在学习过程中经常会忽略封装&#xff0c;⼼想这不就是⼀个访问修饰符么&#xff0c;怎么就是三⼤特性的必要条件了&a…

uniapp的配置和使用

①安装环境和编辑器 注册小程序账号 微信开发者工具下载 uniapp 官网 HbuilderX 下载 首先先下载Hbuilder和微信开发者工具 &#xff08;都是傻瓜式安装&#xff09;&#xff0c;然后注册小程序账号&#xff1a; 拿到appid&#xff1a; ②简单通过demo使用微信开发者工具和…

在Linux系统中设置全局HTTP代理的步骤与技巧

在Linux系统中&#xff0c;设置全局HTTP代理可以方便我们统一管理和控制网络请求。这不仅可以帮助我们加速网络访问&#xff0c;还可以在某些情况下绕过网络限制或实现匿名上网。下面&#xff0c;我将为你详细介绍在Linux系统中设置全局HTTP代理的步骤与技巧。 步骤一&#xf…