为了更好地满足现代 Web 应用程序的需求，很多应用程序都采用 RESTful API 架构。 .NET Core 是一个跨平台、可扩展、快速开发 Web 应用程序的框架。本文将总结基于 .NET Core 设计 RESTful API 的经验，并提供一些示例代码来帮助读者快速上手。
什么是 RESTful API?
RESTful API 是一种基于 REST（Representational State Transfer）架构的 Web API。RESTful API 的设计原则主要包括：
- 使用 HTTP 协议传输数据
- 每个 URL 代表一种资源
- HTTP 方法（如 GET、POST、PUT、DELETE 等）表示对资源的操作
- 资源的表现形式使用 MIME 类型进行描述
- 状态无关，即请求应该是独立的，不依赖于请求之前的任何状态
RESTful API 的设计模式使得它可以轻松地扩展和改进，同时还能与各种前端和后端技术配合使用。
如何在 .NET Core 中设计 RESTful API
在 .NET Core 中设计 RESTful API，需要遵循以下几个步骤：
1. 创建 ASP.NET Core 应用程序
创建 ASP.NET Core 应用程序，可以使用 Visual Studio 2019 或 Visual Studio Code。首先需要选择一个 Web 应用程序模板，例如 ASP.NET Core Web 应用程序（.NET Core）或 ASP.NET Core Empty。
2. 配置路由
在 ASP.NET Core 中，可以使用路由来映射请求的 URL 到适当的处理程序方法。可以使用路由模板来指定 URL 的格式和参数，例如 {controller}/{action}/{id}。
在 .NET Core 中配置路由有两种主要方法：
- 使用
[Route]属性 - 可以在控制器方法上使用[Route]属性指定路由模板。例如，[Route("api/[controller]")]将控制器映射到此 URL：https://localhost:5001/api/{controller}。 - 使用路由配置 - 在
Startup.cs文件中的Configure()方法中使用UseEndpoints()方法可以配置路由。例如，.MapControllers()方法将路由添加到 API 控制器。
3. 实现控制器和操作方法
在 ASP.NET Core 中，可以使用控制器和操作方法来处理请求和返回响应。控制器可以通过继承 Controller 或 ApiController 来创建。
操作方法可以使用 [HttpGet]、[HttpPost]、[HttpPut]、[HttpDelete] 等 HTTP 方法属性进行标记，以指定要执行的操作。此外，还可以使用 [FromBody] 和 [FromQuery] 属性从请求中读取数据。
4. 序列化和反序列化数据
在 .NET Core 中，可以使用对象序列化器（例如 Newtonsoft.Json 或 System.Text.Json）来将对象序列化成 JSON 或其他格式，并将其从 JSON 反序列化为对象。
系统.Text.Json 是 .NET 官方提供的 JSON 序列化器。它的性能比 Newtonsoft.Json 更好，但可定制性较差。在 .NET Core 中，可以使用以下代码来配置序列化：
services.AddControllers().AddJsonOptions(options =>
{
options.JsonSerializerOptions.PropertyNamingPolicy = null;
options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter());
});这将支持序列化 Enum 值，并关闭属性名称的驼峰身份。
5. 实施身份验证和授权
在 ASP.NET Core 中，可以使用身份验证和授权来保护 API 的安全性。可以使用 JWT（JSON Web Tokens）或 OAuth 2.0 / OpenID Connect 等来实现身份验证和授权。
例如，可以使用 Microsoft.AspNetCore.Authentication.JwtBearer 包来实现 JWT 身份验证。可以使用以下代码将 JWT 身份验证添加到应用程序：
-- -------------------- ---- -------
------------------------------------------------------------------
--------------------- --
-
--------------------------------- - --- -------------------------
-
-------------- - -----
---------------- - -----
---------------- - -----
------------------------ - -----
----------- - ----------------------------
------------- - ------------------------------
---------------- - --- ----------------------------------------------------------------------------
--
---6. 部署应用程序
在完成 RESTful API 的设计和开发后，就可以将应用程序部署到 Azure、AWS、Google Cloud 或任何其他云计算平台上。
示例代码
以下是一个使用 ASP.NET Core 实现的通过 HTTP GET 请求返回简单消息的示例：
-- -------------------- ---- -------
---------------
-----------------------
------ ----- -------------------- - --------------
-
---------
------ ------------- -----
-
------ ---------- ---------
-
-此代码使用 ControllerBase 和 [ApiController] 特性创建控制器。它还使用 [Route] 特性来指定路由模板。此控制器只有一个名为 Get() 的操作方法，并使用 [HttpGet] 特性指定要执行的 HTTP 方法。最后，它返回消息“Hello, world!” 作为响应。
结论
.NET Core 提供了无限可能的 RESTful API 设计和实现选项。本文提供了一些指导性和示例代码，以帮助读者了解如何在 .NET Core 中创建和设计 RESTful API，加强操作和学习新技术的能力。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6493f3d948841e989418465a