ASP.NET Core 3.x WebAPI与RESTful API

最新推荐文章于 2025-02-19 19:45:48 发布
转载 最新推荐文章于 2025-02-19 19:45:48 发布 · 1k 阅读 · 1 ·
CC 4.0 BY-SA版权
原文链接：https://blog.youkuaiyun.com/WuLex

Web API

Web API通常指“使用HTTP协议并通过网络调用的API”，由于他使用HTTP协议，所以需要通过URI信息来指定端点

Web API就是一个Web系统，通过访问RUI可以与其进行信息交互。

大多数的Web API并不是RESTful API

Roy Fielding为REST风格的API定制了一套约束规范或者叫做架构风格。

MVC模式

MVC(Model-View-Controller)是一种主要用来构建UI的架构模式

强调 松耦合 关注点分离

MVC不是一个完整的应用程序架构

MVC与API的映射关系

Model，负责处理数据逻辑

View，展示数据，在构建API时，View就是数据或资源的展示，通常使用JSON格式。

Controller，负责View与Model之间的交互。

REST

Representational State Transfer
由Roy Fielding提出
REST是一种架构的风格，这种风格基于一套预定义的规则，这些规则描述了网络资源是如何定义和寻址的。

REST的6个约束

REST所关注的性能，可扩展性，简洁性，互操作性，通信可见性，组件便携性和可靠性都包含在这6个约束里

  1. 客户端-服务端约束：客户端和服务端是分离的，他们可以独自进化。
  2. 无状态：客户端和 服务端的通信必须是无状态的，状态应该包含在请求里。也就是说请求里包含服务端所需要的所有信息，以便服务端可以理解请求并可以创造上下文。
  3. 分层系统：像其他软件架构一样，REST也需要分层结构，但是不允许某层直接访问不相邻的层。
  4. 统一接口：分为4点：
    4.1 资源标识符(URI)
    4.2 资源的操作(也就是方法Method,HTTP动词)
    4.3 自描述的相应(可以认为是媒体类型Media-Type)
    4.4 状态管理(超媒体作为应用状态的引擎HATEOAS，Hypermedia as the Engine of Application State).
  5. 缓存：缓存约束派生于无状态约束，它要求从服务端返回的响应必须明确表明是可缓存的还是不可缓存的。
  6. 按需编码：这允许客户端可以从服务端访问特定的资源而无需知晓如何处理他们。服务器可以扩展或者自定义客户端的功能。
REST-Richardson成熟度模型
  1. 0级，Plain Old XML沼泽：这里HTTP协议只是被永安里进行远程交互，协议的其余部分都用错了，都是RPC风格的实现(例如SOAP，尤其是使用WCF的时候)
  2. 1级，资源：每个资源都映射到一个URI上，但是HTTP方法并没有正确的使用
  3. 2级，动词：正确的使用了HTTP动词，状态码也正确使用了。同时也去掉了不必要的变种。
  4. 3级，超媒体：API支持超媒体作为应用状态的引擎HATEOAS，Hypermedia as the Engine of Application State，引入了可发现性。

WebAPI的对外合约

API消费者需要使用的三个概念

  • 资源的标识
  • HTTP方法
  • 有效载荷(可选)，Payload

资源标识

使用名词而不是动词，让人类能读懂。
  • 例如想要获取系统中的用户。api/getusers是错误的。getusers是获取用户的意思，是动词。
  • 正确的做法是GET api/user
要体现资源的结构关系
  • 假设后端API拥有多个资源，而用户资源与其他资源没有直接关系。那么获取用户就应该使用api/users。 而不是 api/products/users。
  • 通过id获取用户应该api/users/{userId}，而不是api/userId/users。
  • 遵守这种规则能够让api保持很好的可预测性和一致性。
  • 假设需要获取某个公司下的所有员工。使用api/emploess,api/emploees/{companyId}的做法都是错误的。正确的做法是GET api/companies/{companyId}/emploees。
  • 假设想过获取某个公司下的某个员工。使用GET api/companies/{companyId}/employees/{employeeId}。
  • 假设需要进行自定义查询。就应该把过滤或排序的条件放在querystring中。api/users?orderby=name

Rest & HTTP GET

简介

  1. REST简介
  2. HTTP GET Action
  3. 翻页，过滤，排序

HTTP Get

API 资源命名

资源应该使用名词，他是个东西，不是动作
资源应该使用的名词，例如:

  1. api/getusers 就是不正确的
  2. GET api/users 就是正确的
  3. GET api/users/{userId}
  • 其中资源名的单词建议使用复数形式
API资源层次结构
  • 例如 api/department/{departemntId}/emoloyees,这就表示department(部门)和employee(员工)之间时主从关系
  • 而 api/department/{departmentId}/emoloyees/{emoloyeeId}，表示了该部门下的某个员工。
API资源命名-过滤排序

过滤和排序不是资源，应该作为参数传入

  • 例如 api/users?orderby=username
API资源的ID

资源的URI应该永远都是一样的

  • 推荐GUID作为ID来使用
  • 自增int类型的ID，在迁移到新数据库是需要特殊的设定，保证ID值不会发生变化

HTTP方法与资源交互

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-emRxVYPw-1609738086139)(image/20200706112215.jpg)]

  • GET：一般用来获取资源，例如获取资源的集合，或者通过id获取单个资源
  • POST：一般用于添加资源，请求中包含需要添加的资源信息，在响应中返回该资源
  • PUT：一般用于整体的资源更新，请求中包含已更新的资源信息和需要更新的资源的ID，在响应中返回已更新的资源或者返回空204状态码
  • PATCH：一般与用于资源的部分更新，请求是一个model的jsonPatchDocument,还包含需要更新资源的ID，在响应中返回已更新的资源或者返回空204状态码
  • DELETE：一般用于删除资源，请求只需要包含资源的ID，在响应中返回204状态码。
  • HEAD：和GET差不多，但是他不应该返回响应的body，所有没有响应的payload，主要用来获取资源的一些信息，例如查看资源是否可用等。
  • OPTIONS：用来查询某个资源URI的可交互方式有哪些，换句话说就是，使用它可以知道某个URI是否可以执行GET或者POST动作，这些结果通常是在响应的Headers里而不是在body里，所以也没有响应的payload。

状态码

状态码会告诉API的消费者：

  • 请求是否如预期的成功，或者失败
  • 如果出现了错误，具体出错的负责人(服务端、客户端)应该是谁

API主要用的到状态码：

  • 200级别，表示成功
  • 400级别，标识客户端引起的错误
  • 500级别，标识服务器错误
2xx状态码
  • 200：OK ，会附带一些响应
  • 201：Created，表示资源创建成功
  • 204：No Content,成功执行，但是没有返回任何东西
3xx状态码
  • 用于跳转，绝大多数API都不需要使用这类状态码。
4xx状态码
  • 400：Bad request，表示API的消费者发送到服务器的请求是错误的
  • 401：Unauthorized，表示没有权限访问
  • 403：Forbidden，表示用户验证成功了，但是该用户依然无法访问该资源
  • 404：Not found，表示请求的资源不存在
  • 405：Method not allowed，当发送请求到某个资源时，使用的HTTP方法是不允许的，例如使用POST api/countries，而该API只实现了GET，就会返回405
  • 406：Not acceptable，涉及到media type，例如API消费者请求的是application/xml格式的media type，而API只支持application/json
  • 409：Conflict，表示该请求无法完成，因为请求与当前资源的状态有冲突，例如你编辑某个资源数据后，该资源又被其他人更新了，这是你再PUT你的数据就会出现409错误，有时也会出现在尝试创建资源而该资源已存在的情况。
  • 415：Unsupported media type,这个和406正好返回来，例如向服务器提交数据的media type是xml，但是服务器只支持json，那么就会返回415
  • 422：Unprocessable entity，表示请求的格式没问题，但是语义有错误，例如实体验证错误。
5xx状态码
  • 500：Internal server error，表示服务器发生了错误

HTTP GET

  • 单个数据
    • 找到了：200
    • 没找到：404
  • 集合数据
    • 至少一条数据，200
    • 没有数据，也是200

内容协商

Accept Header

如果资源支持多种展现格式，那么消费者可以选择它想要的格式

  • 在请求的Accept Header指定Media Type
    • application/json,application/xml
    • 若未指定，返回默认的application/json
  • 请求的media type不可用时，并且消费者不支持默认格式的时候，返回406
  • 对应asp.net core中的Output formatters
Content-Type Header
  • Media Type
    • application/json
    • application/xml
    • …
  • 代表API接收的输入格式
  • 对应asp.net core里面的Input formatter
4.6：.NET的Web开发RESTful架构和Web API概述（课程共6800字，4段代码举例）
小兔子平安
08-07 166
本课程通过详细的示例和解析，帮助学员掌握了.NET的RESTful架构和Web API的核心概念和应用技巧。我们讨论了每个示例的细节问题，并强调了开发人员在实际应用中应该关注的细微之处。然而，随着技术的不断发展，开发人员需要时刻保持对新技术和最佳实践的关注，并与设计团队合作，提供优秀的用户体验和界面设计。通过不断学习和实践，开发人员将能够构建出高效、可扩展和可维护的Web应用程序，满足不断变化的市场需求。
Restful web api
04-19
超实用的RESTful web API开发参考书，内容翔实，例子实用
.NET 作为客户端调用WEBAPI RESTFUL服务端以及如何开发RESTFUL服务端用于客户端调用
09-23
.NET作为客户端，如何调用WEBAPI RESTFUL的服务端 .NET如何开发RESTFUL服务端
WebAPI前置知识:HTTP与RestfulAPI
ajg87686的博客
04-04 375
对HTTP协议的基本了解是能理解并使用RestFul风格API的基础，在了解了这些基础之后，使用各种RestFul的开发框架才能得心应手。我一开始使用WebApi的时候就因为对这些知识缺乏了解，觉得用起来各种不顺手，直到熟悉了这些HTTP的知识后，使用WebApi开发起来才觉得得心应手，我的理解里，RestFul风格的API即是对HTTP协议良好支持，实现HTTP完整语...
字段缩写ti表示什么_RESTful是什么?
weixin_34984235的博客
12-21 788
Restful接口设计风格？答：域名尽量部署在专用域名下（如https://api.ethanyan.com），如果api很简单，而且不会有进一步的扩展，那么可以考虑放在主域名下（https://www.ethanyan.com/api/）。API版本号应该放入URL，但是也有放在HTTP请求头中的。资源路径，使用名词表示，而且要用其复数形式，一般都是和数据库的表名进行对应。请求方式使用GET表示...
ASP.NET Core 3.x WebAPI入门实例与课程代码解析
标签：“杨旭 WebAPI ASP.NET Core 3.x RESTful FromBody” 6. 杨旭：这个标签很可能是视频教程的作者或是课程讲解者的名字。了解作者背景有助于了解视频教程的专业性。 7. WebAPI：这是一个已经解释过的关键点，...
ASP.NET Core 3.x RESTful Web API开发与内容协商教程
从给定的文件信息中，我们可以提取出一系列关于ASP.NET Core 3.x构建RESTful Web API的知识点，以及内容协商的相关概念和技术细节。以下是详细介绍： ### ASP.NET Core 3.x构建RESTful Web API #### 1. ASP.NET ...
ASP.NET Core 3.x RESTful API 输入验证与自定义Attribute 实践指南
资源摘要信息:"本资源介绍了如何使用ASP.NET Core 3.x技术构建RESTful Web API，并且重点关注了输入验证部分，特别是自定义Attribute的实现与应用。" 知识点详细说明： 1. ASP.NET Core 3.x：ASP.NET Core 3.x是...
ASP.NET Core 3.x RESTful Web API 输入验证实践
在本次学习中，我们将深入探讨如何使用ASP.NET Core 3.x版本构建RESTful Web API，并重点分析其中涉及输入验证的过程和细节。通过分析本资源包文件列表和相关描述，我们可以提取出以下知识点： 1. **ASP.NET Core 3...
ASP.NET Core 3.x RESTful Web API中支持HTTP OPTIONS与XML的实践
**ASP.NET Core 3.x构建RESTful Web API** ASP.NET Core是微软推出的一个开源、跨平台的.NET框架，用于构建现代的Web应用程序和服务。它与.NET Core紧密集成，能够运行在Linux、macOS和Windows系统上。RESTful Web ...
WebApi系列~基于RESTful标准的Web Api
weixin_33753003的博客
02-19 573
回到目录 微软的web api是在vs2012上的mvc4项目绑定发行的，它提出的web api是完全基于RESTful标准的，完全不同于之前的（同是SOAP协议的）wcf和webService，它是简单，代码可读性强的，上手快的，如果要拿它和web服务相比，我会说，它的接口更标准，更清晰，没有混乱的方法名称，有的只有几种标准的请求，如get,post,put,delete等，它们分别对应的几个...
Asp.net WebAPi Restful 的实现和跨域
weixin_34380781的博客
04-09 334
现在实际开发中用webapi来实现Restful接口开发很多，我们项目组前一段时间也在用这东西，发现大家用的还是不那么顺畅，所以这里写一个Demo给大家讲解一下，我的出发点不是如何实现，而是为什么？ 首先我们来看看我么的code吧： control: public class Users { public int UserID { set; get; ...
RESTful 的特点与普通 Web API 的区别
最新发布
情绪不稳定的98年程序员
02-19 1490
它通过遵循这些原则，使得 API 更加简洁、可扩展和易于理解。对于开发者来说，掌握 RESTful 风格可以帮助设计出更高效、更易维护的 API 系统。它遵循一些特定的原则和约束，使得 API 更加简洁、可扩展和易于理解。RESTful API 基于 HTTP 协议，可以被任何支持 HTTP 的客户端调用。RESTful API 的 URI 和方法设计清晰，易于理解和使用。通过 HATEOAS，客户端可以动态发现和访问 API 的资源。通过添加新资源和操作，可以轻松扩展 API 的功能。
Asp.NetCoreWebApi - RESTful Api
weixin_30445169的博客
07-02 1028
REST 常用http动词 WebApi 在 Asp.NetCore 中的实现 3.1. 创建WebApi项目. 3.2. 集成Entity Framework Core操作Mysql 3.2.1. 安装相关的包(为Xxxx.Infrastructure项目安装) 3.2.2. 建立Entity和Context 3.2.3. ConfigureServic...
浅析Rest API与Web API两者之间的差异
WPHunter的编程技术资料库！
01-16 1662
​应用编程接口，或称API，是计算机程序或服务之间相互通信的一种方式。这种通信通常发生在一个API端点上，由客户端消费的程序暴露出来。本文将比较两种流行的构建API的方法：表征性状态转移（REST）API和Web API。 ​
ASP.NET Core Web API 开发-RESTful API实现
weixin_34146805的博客
08-01 496
ASP.NET Core Web API 开发-RESTful API实现 REST 介绍： 符合REST设计风格的Web API称为RESTful API。 具象状态传输（英文：Representational State Transfer，简称REST）是Roy Thomas Fielding博士于2000年在他的博士论文 "Architectural Styles and the ...
Restful和WeBAPI学习笔记
liudanyang_21的博客
06-24 1664
1、restful是基于无状态的,所谓无状态就是说客户端和服务端的每次通话都是独立的,不存在session和cookie之类的保存状态的机制,基于该协议可实现简单的curd操作, 其操作分为get\post\delete\add等，说白了restful指的是一组架构约束条件和原则对安全性要求不高,如果实现较复杂的逻辑推荐使用web service.数据通信默认采用json格式传输,通信方式可以基于ajax,webform,当然服务端取值方式也会不一样. 2asp.net mvc中的webapi也是基于res
Restful API
热门推荐
weixin_46598480的博客
10-11 1万+
REST API 定义如下：一种应用程序编程接口（API 或 Web API），遵循一组关于应用程序如何使用 HTTP 方法相互通信的架构规则。RESTful Web 服务使用 REST API 协议，因此有时也称为 RESTful API。REST 通常用于构建 Web API，允许客户端与服务器之间通过 HTTP 协议进行交互。REST 是由 Roy Fielding 在 2000 年提出的一种架构风格。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
表情包 代码片
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值