前言
RESTful API 是一种基于 HTTP 协议与客户端交互的 Web API 设计风格。通过此种设计风格，可以使得客户端和服务器之间的交互变得更加简单、可扩展和可维护。本文将详细介绍 C# 和 ASP.NET Core 中的 RESTful API 实例，涵盖了 API 的设计、构建和测试，以及相关理论知识的讲解，旨在为读者提供一些指导和借鉴。
一、API 的设计
在设计 API 的时候，需要考虑以下几个方面：
1. API 接口的定位和语义
API 接口的定位和语义 指的是接口的具体功能和作用。开发者在设计接口时应该明确，这个 API 接口所实现功能的是什么，对应的业务领域是什么。这样可以保证 API 的设计满足业务需求，并且即使接口上下游发生改变，接口的功能描述也不会发生改变。
2. 资源的唯一标识符
在 RESTful API 的设计中，每个资源都有一个 唯一标识符。这个唯一标识符要使用URI作为标识，用来标识资源的类型和具体信息。例如，我们有一个用户的资源，我们可以使用以下 URI 来标识它：
结构：/users/{id}
示例：/users/1233. HTTP 动作与状态码
RESTful API 的交互是基于 HTTP 协议的，因此在设计 API 时要尽可能地利用好 HTTP 协议中定义的方法和状态码，用统一的API设计规则对不同的 HTTP 动作和状态码做出相应的处理。常见的 HTTP 动作有 GET、POST、PUT、DELETE，常见的状态码有 200、201、204、400、401、404、409、500 等。其中，2xx 状态码代表成功，3xx 状态码代表重定向，4xx 状态码代表请求错误，5xx 状态码代表服务器错误。
二、API 的构建
1. 使用 ASP.NET Core 构建 RESTful API
ASP.NET Core 是跨平台的高性能框架，能够构建具备高度架构灵活性、易测试性和良好的开发体验的 Web 应用。我们可以使用ASP.NET Core的 WebAPI 框架来构建 RESTful API。
首先，我们需要创建一个 ASP.NET Core 项目，并在项目中添加 NuGet 包 Microsoft.AspNetCore.Mvc。然后，我们创建一个控制器类，并在类中编写对应的 API 接口。
例如，下面是一个 UsersController 类，它有两个方法：GetAllUsers 和 GetUserById。GetAllUsers 方法返回所有用户，GetUserById 方法根据 ID 返回具体的用户信息。
-- -------------------- ---- -------
----- -------------------------
----- ---------------------------
---------------
-----------------------
------ ----- --------------- - --------------
-
------- ------ ---------- ----- - --- ----------
-
--- ---- -
-- - --
---- - --------
--- - --
--
--- ---- -
-- - --
---- - ------
--- - --
-
--
---------
------ ------------------------ -------------
-
------ ------
-
-----------------
------ ------------------ --------------- ---
-
--- ---- - ------------- -- ---- -- ---------------------
-- ----- -- -----
-
------ -----------
-
------ -----
-
-2. 数据库的配置
在实际的应用中，我们往往需要将数据存储到数据库中。在这里，我们使用官方 NuGet 包Microsoft.EntityFrameworkCore。
我们需要配置 DbContext，并通过依赖注入向控制器提供访问数据库的能力。例如，下面是一个 DbContext 类：
-- -------------------- ---- -------
----- ------------------------------
------ ----- ------------- - ---------
-
------ --------------------------------------------- -------- - -------------
-
-
------ ----------- ----- - ---- ---- -
-在配置文件 appsettings.json 中，我们需要添加数据库连接字符串的配置。
{
"ConnectionStrings": {
"UserDb": "server=localhost;port=3306;database=users;user=root;password=123456"
}
}然后，在 Startup.cs 文件中，我们需要在 ConfigureServices 方法中添加以下代码以配置数据库：
-- -------------------- ---- -------
------ ---- ------------------------------------ ---------
-
-------------------------------------------- --
-
--------------------------------------------------------------
---
----------------------------------- ------------------
--------------------------
-3. Repository 层的构建
Repository 层是数据操作的中间层，它为控制器提供对数据实现增删改查的能力。在本示例中，我们将 UserRepository 注册到 ASP.NET Core 项目中，并在控制器中通过依赖注入获取 UserRepository 实例。
下面是 UserRepository 类的示例代码：
-- -------------------- ---- -------
----- ---------------------------
----- ------------
------ ----- -------------- - ---------------
-
------- -------- ------------- ---------
------ ---------------------------- --------
-
-------- - --------
-
------ ----------------- -------------
-
------ ------------------------
-
------ ---- --------------- ---
-
------ ------------------------------- -- ---- -- ----
-
------ ---- --------------- -----
-
-------------------------
-----------------------
------ -----
-
------ ---- --------------- -----
-
----------------------
-----------------------
-
------ ---- --------------- -----
-
----------------------
-----------------------
-
-4. API 的测试
最后，我们需要测试 API 是否正常工作。我们可以使用 Postman 或者类似的 HTTP 协议测试工具测试 API。
例如，我们可以使用 Postman 发送 GET 请求来获取所有用户：
请求 URL：http://localhost:5000/users
接口返回数据：
-- -------------------- ---- -------
-
-
----- --
------- --------
------ --
--
-
----- --
------- ------
------ --
-
-三、总结
本文介绍了在 C# 和 ASP.NET Core 中如何构建 RESTful API，并包含了相关理论知识的详细讲解。读者可以通过本文了解到 API 的设计、构建和测试的流程，同时了解到如何使用 ASP.NET Core 的 WebAPI 框架来构建 RESTful API。如果您对此有更多的疑问或者建议，欢迎在评论区留言交流。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64ab7e4748841e989475423b