ASP.NET Core WebAPI中，创建非RESTful风格的和RESTful风格的Controller一些区别

最新推荐文章于 2024-09-08 16:48:17 发布
最新推荐文章于 2024-09-08 16:48:17 发布
阅读量1.2k 收藏 27
点赞数 20
分类专栏： ASP.NET Core Web API 文章标签： asp.net restful 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/WuLex/article/details/137845691
版权
本文探讨了在ASP.NETCore中，RESTful风格和非RESTful风格的API设计差异，包括URL结构、HTTP动词使用、动作方法命名以及适用场景。非RESTful风格如RPC和自定义操作提供了更大的灵活性，但可能不遵循标准的CRUD操作规则。
摘要由CSDN通过智能技术生成

在 ASP.NET Core WebAPI 中，创建非 RESTful 风格的 API 和创建 RESTful 风格的 Controller 有一些区别。首先，让我们明确一下 RESTful 风格的特点：

RESTful 风格的 Controller 特点：

  • 使用 HTTP 动词（GET、POST、PUT、DELETE 等）对资源执行 CRUD 操作。
  • 资源使用统一的 URL 来标识。
  • 使用 HTTP 状态码来表示操作的结果。
  • 符合 REST 架构风格的规范和约定。

现在，让我们看看如何创建一些非 RESTful 风格的 API 以及它们与 RESTful 风格的 Controller 之间的区别。

1. 非 RESTful 风格的 API

1.1 RPC 风格（Remote Procedure Call）

RPC 风格的 API 类似于传统的远程过程调用，它强调的是对操作或方法的调用而不是资源的操作。

// 非 RESTful 风格的 Controller，使用 RPC 风格
[ApiController]
public class RpcController : ControllerBase
{
    [HttpPost]
    [Route("api/rpc/add")]
    public IActionResult Add(int a, int b)
    {
        int result = a + b;
        return Ok(result);
    }

    [HttpPost]
    [Route("api/rpc/multiply")]
    public IActionResult Multiply(int a, int b)
    {
        int result = a * b;
        return Ok(result);
    }
}

在这个例子中，我们有一个 RpcController，它有两个动作方法 Add 和 Multiply，分别执行加法和乘法操作。

1.2 自定义操作

有时候，你可能想要在 API 中定义一些非标准的操作，这也是非 RESTful 风格的一个例子。

// 非 RESTful 风格的 Controller，使用自定义操作
[ApiController]
public class CustomController : ControllerBase
{
    [HttpPost]
    [Route("api/custom/resetPassword")]
    public IActionResult ResetPassword(string username)
    {
        // Reset password logic
        return Ok();
    }

    [HttpPost]
    [Route("api/custom/sendEmail")]
    public IActionResult SendEmail(string recipient, string message)
    {
        // Send email logic
        return Ok();
    }
}

在这个例子中，我们有一个 CustomController，它有两个自定义的动作方法 ResetPassword 和 SendEmail，执行特定的操作。

2. 区别

2.1 URL 结构
  • RESTful 风格：资源在 URL 中表示，使用 HTTP 动词来对资源执行操作。
    • 例如：/api/users, /api/products/1, /api/orders
  • 非 RESTful 风格：URL 可以更加自由地定义，重点是操作或方法的名称。
    • 例如：/api/rpc/add, /api/custom/resetPassword
2.2 动作方法名称
  • RESTful 风格：动作方法的名称应该是与资源操作相关的名词或动词，例如 Get, Post, Put, Delete 等。
  • 非 RESTful 风格：动作方法的名称可以更加自由，通常是对操作的描述或动词。
2.3 使用场景
  • RESTful 风格：适合于对资源进行 CRUD 操作，并且遵循 RESTful 的设计原则。
  • 非 RESTful 风格：适合于一些不符合标准 CRUD 操作的场景，例如特定的计算、业务流程或功能性操作。

总结

在 ASP.NET Core WebAPI 中，你可以根据需求选择 RESTful 风格或非 RESTful 风格来设计 API。RESTful 风格是一个通用的设计范式，适用于大多数的 WebAPI 场景。非 RESTful 风格的 API 则可以更加灵活地根据特定的业务需求来设计。根据你的应用需求和团队的技术栈，选择适合的风格来设计 API 是最重要的。

详细比较

当在 ASP.NET Core WebAPI 中创建非 RESTful 风格的 API 和 RESTful 风格的 Controller 时，有几个关键的区别。这些区别包括 URL 结构、动作方法命名、HTTP 方法使用等方面。让我们详细比较一下：

1. RESTful 风格的 Controller

在 RESTful 风格的 Controller 中，我们遵循 REST 架构风格的原则，使用 HTTP 动词（GET、POST、PUT、DELETE 等）来操作资源，并且资源通过统一的 URL 结构来标识。

// RESTful 风格的 Controller
[ApiController]
[Route("api/[controller]")]
public class ProductsController : ControllerBase
{
    private readonly List<Product> _products = new List<Product>
    {
        new Product { Id = 1, Name = "Product 1" },
        new Product { Id = 2, Name = "Product 2" }
    };

    [HttpGet]
    public IActionResult GetProducts()
    {
        return Ok(_products);
    }

    [HttpGet("{id}")]
    public IActionResult GetProduct(int id)
    {
        var product = _products.FirstOrDefault(p => p.Id == id);
        if (product == null)
        {
            return NotFound();
        }
        return Ok(product);
    }

    [HttpPost]
    public IActionResult CreateProduct([FromBody] Product product)
    {
        // Create product logic
        _products.Add(product);
        return CreatedAtAction(nameof(GetProduct), new { id = product.Id }, product);
    }

    [HttpPut("{id}")]
    public IActionResult UpdateProduct(int id, [FromBody] Product product)
    {
        // Update product logic
        var existingProduct = _products.FirstOrDefault(p => p.Id == id);
        if (existingProduct == null)
        {
            return NotFound();
        }
        existingProduct.Name = product.Name;
        return NoContent();
    }

    [HttpDelete("{id}")]
    public IActionResult DeleteProduct(int id)
    {
        // Delete product logic
        var product = _products.FirstOrDefault(p => p.Id == id);
        if (product == null)
        {
            return NotFound();
        }
        _products.Remove(product);
        return NoContent();
    }
}

在这个示例中，我们有一个 ProductsController，它包含了对产品资源执行 CRUD 操作的标准 RESTful 动作方法。这些动作方法包括 GetProducts、GetProduct、CreateProduct、UpdateProduct 和 DeleteProduct。

2. 非 RESTful 风格的 API

非 RESTful 风格的 API 可能使用自定义的动作方法名称，不一定遵循 CRUD 操作和标准的 HTTP 动词约定，更多地关注于操作或者业务逻辑。

2.1 自定义动作方法名称
// 非 RESTful 风格的 Controller
[ApiController]
[Route("api/[controller]")]
public class CustomController : ControllerBase
{
    [HttpPost]
    [Route("api/custom/resetPassword")]
    public IActionResult ResetPassword(string username)
    {
        // Reset password logic
        return Ok();
    }

    [HttpPost]
    [Route("api/custom/sendEmail")]
    public IActionResult SendEmail(string recipient, string message)
    {
        // Send email logic
        return Ok();
    }
}

在这个示例中，我们有一个 CustomController，它包含了自定义的动作方法 ResetPassword 和 SendEmail。这些方法不是标准的 CRUD 操作，而是执行特定的操作，例如重置密码和发送电子邮件。

2.2 RPC 风格
// 非 RESTful 风格的 Controller，使用 RPC 风格
[ApiController]
[Route("api/[controller]")]
public class RpcController : ControllerBase
{
    [HttpPost]
    [Route("api/rpc/add")]
    public IActionResult Add(int a, int b)
    {
        int result = a + b;
        return Ok(result);
    }

    [HttpPost]
    [Route("api/rpc/multiply")]
    public IActionResult Multiply(int a, int b)
    {
        int result = a * b;
        return Ok(result);
    }
}

在这个示例中，我们有一个 RpcController，它包含了类似 RPC 风格的动作方法 Add 和 Multiply，执行数学计算而不是 CRUD 操作。

3. 区别对比

3.1 URL 结构
  • RESTful 风格：资源在 URL 中表示，通常使用控制器名称作为资源的一部分，例如 /api/products, /api/orders.
  • 非 RESTful 风格：URL 可以更加自由地定义，不一定反映资源，可能反映操作，例如 /api/custom/resetPassword, /api/rpc/add.
3.2 动作方法命名
  • RESTful 风格：动作方法命名通常是标准的 CRUD 操作动词，例如 Get, Post, Put, Delete.
  • 非 RESTful 风格：动作方法命名可以更加自定义，反映特定的操作或业务逻辑，例如 ResetPassword, SendEmail, Add, Multiply.
3.3 HTTP 方法使用
  • RESTful 风格：使用标准的 HTTP 方法来执行操作，例如 GET、POST、PUT、DELETE.
  • 非 RESTful 风格：可能会根据具体情况自定义 HTTP 方法的使用，或者仅仅使用 POST 方法来模拟各种操作。
3.4 使用场景
  • RESTful 风格：适合标准的 CRUD 操作，与资源的交互，API 遵循一致的设计原则和约定。
  • 非 RESTful 风格：适合非标准的操作，特定的业务流程，或者需要更加灵活的 API 设计。

总结

  • RESTful 风格：适用于大多数 WebAPI 场景，遵循标准的 HTTP 方法和 URL 结构，提供了一种一致、符合约定的设计方式。
  • 非 RESTful 风格：适用于非标准的操作、特定的业务逻辑或需要更加灵活的 API 设计。

对比 RESTful 和非 RESTful 风格的请求路径以及提交数据

当对比 RESTful 和非 RESTful 风格的请求路径以及提交数据时，我们可以列出每个风格下的示例路径和提交数据。

RESTful 风格

1. 请求路径和提交数据示例：

  1. GET 请求：获取所有产品列表

    • 请求路径： GET /api/products
    • 提交数据： 无（GET 请求通常不包含提交数据）

  2. GET 请求：获取特定产品

    • 请求路径： GET /api/products/1
    • 提交数据： 无（GET 请求通常不包含提交数据）

  3. POST 请求：创建新产品

    • 请求路径： POST /api/products
    • 提交数据：
      {
  "name": "New Product",
  "price": 99.99
}

  4. PUT 请求：更新特定产品

    • 请求路径： PUT /api/products/1
    • 提交数据：
      {
  "name": "Updated Product Name",
  "price": 109.99
}

  5. DELETE 请求：删除特定产品

    • 请求路径： DELETE /api/products/1
    • 提交数据： 无（DELETE 请求通常不包含提交数据）

非 RESTful 风格

2. 请求路径和提交数据示例：

  1. POST 请求：重置用户密码

    • 请求路径： POST /api/custom/resetPassword
    • 提交数据：
      {
  "username": "john_doe",
  "newPassword": "new_secure_password"
}

  2. POST 请求：发送电子邮件

    • 请求路径： POST /api/custom/sendEmail
    • 提交数据：
      {
  "recipient": "example@example.com",
  "subject": "Hello",
  "body": "This is an email message."
}

  3. POST 请求：执行加法计算

    • 请求路径： POST /api/rpc/add
    • 提交数据：
      {
  "a": 10,
  "b": 5
}

  4. POST 请求：执行乘法计算

    • 请求路径： POST /api/rpc/multiply
    • 提交数据：
      {
  "a": 8,
  "b": 4
}

这些示例展示了在 RESTful 风格和非 RESTful 风格下的请求路径和提交数据的区别。在 RESTful 风格中，请求路径通常反映资源的结构，而在非 RESTful 风格中，请求路径更关注操作或特定功能。提交的数据则根据不同的操作和功能进行了示例化。

.NET跨平台
关注
专栏目录
构建RESTful API：ASP.NET Core Web API的魔法之旅
java专栏
08-01 1030
REST，即表述性状态转移（Representational State Transfer），是一种设计风格，用于网络应用的交互。RESTful API就是遵循这种风格的API，它使用标准的HTTP方法，以JSON或XML格式传输数据。创建C#类来定义你的数据模型。set;set;set;
【.Net动态Web API】动态方法RESTful风格
成长的足迹
04-18 364
【.Net动态Web API】动态方法RESTful风格就介绍到这边啦！这个系列预计一天一篇文章，想要学习的可以关注起来！文章会持续更新，大家有想要了解的功能点或者话题，可以在评论区告诉我！
WebApiCore:使用EF Core（代码优先方法），内置依赖项注入，Automapper，FluentValidation的ASP.NET Web API Core应用程序。 允许使用RESTful服务对数据执行CRUD操作
04-29
WebApiCore ASP.NET Web API Core应用程序，使用EF Core（代码优先方法）。允许对data执行CRUD操作。
对RESTful Web API的理解与设计思路
anw53724的博客
03-06 225
距离上一篇关于Web API的文章（如何实现RESTful Web API的身份验证）有好些时间了，在那篇文章中提到的方法是非常简单而有效的，我在实际的项目中就这么用了，代码经过一段时间的磨合，已经很稳定了，所以我打算写篇总结，并在最近这段时间里提供一个ASP.net Web API的综合例子。 对四个HTTP方法的理解 众所周知，HTTP有四个方法，GET、POST、PUT和DEL...
API 架构（RPC风格、RESTful风格）
最新发布
qq_20236937的博客
09-08 1029
RPC和RESTful是两种不同的接口设计风格，RPC更关注远程服务调用的过程，而RESTful更关注资源的表述和状态转移。在实际应用中，可以根据项目需求和团队偏好选择适合的接口设计风格。
Web API 、Restful的好处、 微服务 学习总结
u010133378的专栏
06-16 1804
1、定义：常规的WEB API就是指使用HTTP协议通过网络调用的API； 其实就是一个WEB系统，对外提供给别人调用的API，这种调用通常是程序的方式，而不是简简单单的浏览器中输入URL访问。 像我们常规使用的WEB Service、c#的一般处理程序、WCF都属于WEB API、以及Java中的响应Ajax的Servlet都算是web api 2、使用原生H...
Restful和WeBAPI学习笔记
liudanyang_21的博客
06-24 1564
1、restful是基于无状态的,所谓无状态就是说客户端和服务端的每次通话都是独立的,不存在session和cookie之类的保存状态的机制,基于该协议可实现简单的curd操作, 其操作分为get\post\delete\add等，说白了restful指的是一组架构约束条件和原则对安全性要求不高,如果实现较复杂的逻辑推荐使用web service.数据通信默认采用json格式传输,通信方式可以基于ajax,webform,当然服务端取值方式也会不一样. 2asp.net mvc中的webapi也是基于res
使用ASP.NET Core 5.0构建WebApi框架源码
05-14
ASP.NET Core 5.0是微软推出的一个跨平台的开源框架，用于构建现代云应用程序，包括WebAPI。相比之前的3.0版本，5.0带来了许多改进和新特性，使得开发更加高效且易于维护。本篇文章将深入探讨如何使用ASP.NET Core ...
【ASP.NET编程知识】.Net Core WebApi的简单创建以及使用方法.docx
05-15
.NET Core WebApi 是一个基于 ASP.NET Core 框架的 Web API 框架，允许开发者创建 RESTful 风格的 Web 服务。下面是创建和使用 .NET Core WebApi 的步骤和知识点： 一、创建项目 * 使用 Visual Studio 2019 创建一...
.NET 作为客户端调用WEBAPI RESTFUL服务端以及如何开发RESTFUL服务端用于客户端调用
09-23
1. 配置WebAPI项目：使用ASP.NET MVC或ASP.NET Core创建一个新的WebAPI项目。确保在项目中引用必要的NuGet包，如Microsoft.AspNet.WebApi.Core或Microsoft.AspNetCore.Mvc。 2. 定义控制器：WebAPI的核心是控制器，...
Restful web api
04-19
超实用的RESTful web API开发参考书，内容翔实，例子实用
代码不用restful的造成的影响
yzhao66的博客
06-01 207
代码不用restful造成的影响
php 创建简单的Restful WebAPI（一）
weixin_30323961的博客
08-27 294
　　Restful API现在非常的流行啊，目前工作的项目也使用了ASP.NETWebAPI技术。用下来的感觉是前台数据的展现层可以和后台数据的处理层解耦性很好。所以在开发阶段，前台数据展现页面布局和后台数据处理调整起来都很方便。Restful API利用了http协议，配合一些类似backbone这样的js mvc框架非常好用。 　　最近有一个需求是用php实现一个简单的Res...
MVC+WebApi+Restful
weixin_30307267的博客
09-17 186
Restful四个关键字 Get，Post,Put,Delete,这是重点！ 创建一个WebApi，MVC模式 路由配置文件，跟Web的不是一个文件，要注意。 defaults里的默认控制器是我随手加的，对于api来说不应该有默认，要什么就给什么。 默认控制器ValueController中有 GetGetGetGetGetGetGetGetGetGetGetGe...
WebApI-RestFul架构
MrLsss的博客
03-23 242
REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征）性状态转移。REST指的是一组架构约束条件和原则。如果一个架构符合REST的约束条件和原则，我们就称它为RESTful架构。
RESTful WebApi初步学习
qq_40674490的博客
05-04 447
1 RESTful：架构风格，就是以资源为视角，来描述服务的。 因为移动互联网时代来临：用json/xml来描述，http方法 统一了数据操作 它的目标是用来找数据，而不是看重接口。 表现层的状态转换；资源；统一接口；URI；无状态； 资源：实体就是资源，json/xml 数据流 统一接口：CRUD，是通过http的method体现 get,post.put/patch.delete ...
【ASP.NET Core 基础知识】--Web API--RESTful设计原则
喵叔
02-03 1915
RESTful设计的背景源于Roy Fielding博士在他2000年的博士论文中提出的REST（Representational State Transfer）架构风格。REST旨在构建可伸缩、可维护的网络应用，强调资源的统一标识、无状态通信和统一接口。基于HTTP协议，RESTful设计通过简化架构、提高系统可靠性，促使Web服务的广泛应用。RESTful是一种基于REST原则的架构风格，用于设计网络应用程序和服务。
.Net Core webapi RestFul 统一接口数据返回格式
lwpoor123的博客
12-21 2341
json对象中data是返回的实际结果对象，可以是一个对象、一个list、一个字符串、一个数字......分别实现类带有泛型的 ApiResponse 类和 ApiResponse 类。的隐式转换，所以就完美解决这个问题，大大减少了代码量。注意在泛型类中，使用运算符重载，实现了。中，我们定义了一个运算符重载，实现了。但是整体的json格式要以上面的为准。2、使用过滤器(Filter)实现。类型呀，这不是类型不一致吗？1、自定义一个统一返回类。但这接口的返回值明明是。创建对应的接口和实现类。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值