前言
RESTful API 是一种常见的 Web API 设计风格，它使用 HTTP 协议进行通信，通过 HTTP 动词（GET、POST、PUT、DELETE 等）对资源进行操作，返回 JSON 或 XML 格式的数据。ASP.NET Core 是微软推出的跨平台的开源 Web 开发框架，它提供了丰富的功能和工具，可以轻松地构建 RESTful API。
本文将介绍如何使用 ASP.NET Core 构建 RESTful API，包括 API 的设计原则、路由配置、数据序列化、异常处理、身份验证和授权等方面。通过本文的学习，读者将能够掌握 ASP.NET Core 构建 RESTful API 的基本技能，为实际开发提供指导和参考。
API 的设计原则
在设计 RESTful API 时，需要遵循一些基本的设计原则，包括：
- 使用 HTTP 动词对资源进行操作，如 GET、POST、PUT、DELETE 等。
- 使用 URI（统一资源标识符）表示资源，如 /api/users。
- 使用 HTTP 状态码表示操作结果，如 200 表示成功、400 表示请求错误、401 表示未授权、404 表示资源不存在等。
- 使用 JSON 或 XML 格式的数据进行交互，可以使用 ASP.NET Core 内置的数据序列化工具进行转换。
- 使用版本控制管理 API 的版本，可以使用 URI 或请求头等方式进行控制。
路由配置
在 ASP.NET Core 中，可以通过路由配置来定义 API 的 URI 和操作方法的映射关系。可以使用以下方式进行路由配置：
- 在 Startup.cs 文件的 ConfigureServices 方法中添加 MVC 服务：
public void ConfigureServices(IServiceCollection services)
{
services.AddMvc();
}- 在 Startup.cs 文件的 Configure 方法中添加路由配置：
-- -------------------- ---- -------
------ ---- ----------------------------- ---- ------------------- ----
-
-----------------
-------------------------- --
-
---------------------------
---
-- 在控制器类中添加路由属性和操作方法：
-- -------------------- ---- -------
---------------------------
---------------
------ ----- --------------- - --------------
-
---------
------ ------------- -----
-
-- ----- ------
-
-----------------
------ ------------- ------- ---
-
-- ----- ------
-
----------
------ ------------- --------------- ---- -----
-
-- ----- -----
-
-----------------
------ ------------- ------- --- ---------- ---- -----
-
-- ----- ------
-
--------------------
------ ------------- ---------- ---
-
-- ----- ------
-
-在上面的代码中，使用 [Route] 属性定义了控制器的 URI，使用 [HttpGet]、[HttpPost]、[HttpPut]、[HttpDelete] 等属性定义了操作方法的 HTTP 动词和 URI。当请求进入控制器后，ASP.NET Core 将自动根据 URI 和 HTTP 动词来选择对应的操作方法进行处理。
数据序列化
在 RESTful API 中，数据的交互通常使用 JSON 或 XML 格式的数据。ASP.NET Core 提供了内置的数据序列化工具，可以方便地将对象序列化为 JSON 或 XML 格式的数据。可以使用以下方式进行数据序列化：
- 在 Startup.cs 文件的 ConfigureServices 方法中添加 JSON 和 XML 序列化服务：
-- -------------------- ---- -------
------ ---- ------------------------------------ ---------
-
-----------------
----------------------- --
-
-------------------------------------------------- - -----
------------------------------------------------- - -----
--
------------------------------
-- 在操作方法中返回对象：
[HttpGet]
public IActionResult Get()
{
var users = _userService.GetUsers();
return Ok(users);
}在上面的代码中，使用 Ok 方法返回对象，ASP.NET Core 将自动使用 JSON 或 XML 格式的数据进行序列化，并设置 Content-Type 头为 application/json 或 application/xml。
异常处理
在 RESTful API 中，异常处理是非常重要的一部分，它可以帮助我们更好地处理错误和异常情况，提高 API 的健壮性和可靠性。ASP.NET Core 提供了内置的异常处理机制，可以方便地处理各种异常情况。可以使用以下方式进行异常处理：
- 在 Startup.cs 文件的 Configure 方法中添加全局异常处理中间件：
-- -------------------- ---- -------
------ ---- ----------------------------- ---- ------------------- ----
-
-----------------
-------------------------------- --
-
------------------ ------- --
-
--- --------- - -------------------------------------------------------
--- ---------- - --------- -- ----------------- - ----------------------- - -----------------------------------
--------------------------- - ----------------
---------------------------- - -------------------
--- ----- - --- -----
-
---------- - ----------------
------- - -----------------
--
----- -------------------------------------------------------------
---
---
-------------------------- --
-
---------------------------
---
-在上面的代码中，使用 UseExceptionHandler 方法添加全局异常处理中间件。当 API 抛出异常时，ASP.NET Core 将自动捕获异常并调用中间件进行处理。在中间件中，可以根据异常类型设置 HTTP 状态码和错误信息，并将其序列化为 JSON 格式的数据返回给客户端。
身份验证和授权
在 RESTful API 中，身份验证和授权是非常重要的一部分，它可以帮助我们保护 API 的安全性和隐私性，防止未授权的访问和操作。ASP.NET Core 提供了丰富的身份验证和授权机制，可以方便地进行身份验证和授权。可以使用以下方式进行身份验证和授权：
- 在 Startup.cs 文件的 ConfigureServices 方法中添加身份验证服务：
-- -------------------- ---- -------
------ ---- ------------------------------------ ---------
-
---------------------------------- --
-
--------------------- - ---------------------------------------
--
--------------------- --
-
--------------------------------- - --- -------------------------
-
-------------- - -----
---------------- - -----
---------------- - -----
------------------------ - -----
----------- - ----------------------------
------------- - ------------------------------
---------------- - --- ----------------------------------------------------------------------------
--
---
--------------------------------- --
-
-------------------------- ------ -- -----------------------------
---
------------------
-在上面的代码中，使用 AddAuthentication 方法添加身份验证服务，并设置默认的身份验证方案为 JwtBearerDefaults.AuthenticationScheme。使用 AddJwtBearer 方法添加 JWT 身份验证方案，并设置 TokenValidationParameters 参数来验证 JWT 的有效性和合法性。使用 AddAuthorization 方法添加授权服务，并设置授权策略，可以根据角色、声明等进行授权。
- 在 Startup.cs 文件的 Configure 方法中添加身份验证和授权中间件：
-- -------------------- ---- -------
------ ---- ----------------------------- ---- ------------------- ----
-
-----------------
------------------------
-----------------------
-------------------------- --
-
---------------------------
---
-在上面的代码中，使用 UseAuthentication 和 UseAuthorization 方法添加身份验证和授权中间件。当 API 接收到请求时，ASP.NET Core 将自动进行身份验证和授权，根据授权策略来判断是否允许访问和操作。
示例代码
完整的 ASP.NET Core RESTful API 示例代码如下：
-- -------------------- ---- -------
----- -------
----- ---------------------------
----- ------------
----- -----------
----- -----------------
----- -----------------------
----- ----------------------------------------------
----- -----------------------------------
----- -----------------------------
----- ---------------------------------
----- -----------------------------
----- --------------------------
----- -------------------------
----- -----------------------------------
----- -----------------------------------------
----- -----------------------------
----- -------------------------------
----- ------------------
----- --------------------
--------- ----------
-
------ ----- -------
-
------ ---------------------- --------------
-
------------- - --------------
-
------ -------------- ------------- - ---- -
------ ---- ------------------------------------ ---------
-
---------------------------------- --
-
--------------------- - ---------------------------------------
--
--------------------- --
-
--------------------------------- - --- -------------------------
-
-------------- - -----
---------------- - -----
---------------- - -----
------------------------ - -----
----------- - ----------------------------
------------- - ------------------------------
---------------- - --- ----------------------------------------------------------------------------
--
---
--------------------------------- --
-
-------------------------- ------ -- -----------------------------
---
----------------------------------- ---------------
-----------------
----------------------- --
-
-------------------------------------------------- - -----
------------------------------------------------- - -----
--
------------------------------
-
------ ---- ----------------------------- ---- ------------------- ----
-
-----------------
------------------------
-----------------------
-------------------------------- --
-
------------------ ------- --
-
--- --------- - -------------------------------------------------------
--- ---------- - --------- -- ----------------- - ----------------------- - -----------------------------------
--------------------------- - ----------------
---------------------------- - -------------------
--- ----- - --- -----
-
---------- - ----------------
------- - -----------------
--
----- -------------------------------------------------------------
---
---
-------------------------- --
-
---------------------------
---
-
-
---------------------------
---------------
------ ----- --------------- - --------------
-
------- -------- ------------ -------------
------ ---------------------------- ------------
-
------------ - ------------
-
---------
------ ------------- -----
-
--- ----- - ------------------------
------ ----------
-
-----------------
------ ------------- ------- ---
-
--- ---- - -------------------------
-- ----- -- -----
-
----- --- ------------------------ ---- -- ---- --- ---------
-
------ ---------
-
----------
---------------- - ---------
------ ------------- --------------- ---- -----
-
---------------------------
------ ---------------------------- --- - -- - ------- -- ------
-
-----------------
---------------- - ---------
------ ------------- ------- --- ---------- ---- -----
-
--- ------------ - -------------------------
-- ------------- -- -----
-
----- --- ------------------------ ---- -- ---- --- ---------
-
------- - ---
------------------------------
------ ------------
-
--------------------
---------------- - ---------
------ ------------- ---------- ---
-
--- ------------ - -------------------------
-- ------------- -- -----
-
----- --- ------------------------ ---- -- ---- --- ---------
-
----------------------------
------ ------------
-
-
------ --------- ------------
-
----------------- -----------
---- ----------- ----
---- ------------ ------
---- --------------- ------
---- -------------- ----
-
------ ----- ----------- - ------------
-
------- -------- ---------- ------ - --- ----------
-
--- ---- - -- - -- ---- - -------- --- - -- --
--- ---- - -- - -- ---- - ------ --- - -- --
--- ---- - -- - -- ---- - ---------- --- - -- -
--
------ ----------------- ----------
-
------ -------
-
------ ---- ----------- ---
-
------ ----------------------- -- ---- -- ----
-
------ ---- ------------ -----
-
------- - ------------ -- ----- - --
-----------------
-
------ ---- --------------- -----
-
--- ------------ - ----------------------- -- ---- -- ---------
-- ------------- -- -----
-
----------------- - ----------
---------------- - ---------
-
-
------ ---- -------------- ---
-
--- ------------ - ----------------------- -- ---- -- ----
-- ------------- -- -----
-
----------------------------
-
-
-
------ ----- ----
-
------ --- -- - ---- ---- -
------ ------ ---- - ---- ---- -
------ --- --- - ---- ---- -
-
------ ----- -----
-
------ --- ---------- - ---- ---- -
------ ------ ------- - ---- ---- -
-
------ ----- ----------------- - ---------
-
------ ------------------------ -------- - -------------
-
-
-
-总结
本文介绍了如何使用 ASP.NET Core 构建 RESTful API，包括 API 的设计原则、路由配置、数据序列化、异常处理、身份验证和授权等方面。通过本文的学习，读者可以掌握 ASP.NET Core 构建 RESTful API 的基本技能，为实际开发提供指导和参考。当然，实际的开发中还有很多细节和问题需要注意，需要结合具体的业务场景和需求进行调整和优化。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/662b8824d3423812e491b603