ASP.NET Core初学者指南：Web API - Telerik.com

如果您是.NET平台的新手或刚接触该领域，那么了解Web API是非常重要的。Web API是一种通过HTTP协议在服务器和客户端之间进行通信的强大且安全的应用程序，当前市场对它的需求非常高。

什么是Web API？

应用程序编程接口（API）本质上是一种HTTP服务，旨在以简单而集中的方式在不同应用程序之间实现通信。

微软通过ASP.NET框架提供了构建Web API的工具，这些API可以被任何客户端（如浏览器、桌面应用程序和移动设备）访问。

ASP.NET Web API支持构建REST和SOAP服务，以下是使用ASP.NET Web API的一些优势：

使用标准HTTP动词（GET、POST、PUT、DELETE）处理所有CRUD操作。
完全支持路由功能。
通过MediaTypeFormatter以JSON和XML格式生成响应。
可在IIS上托管，也支持自托管。
支持模板绑定和验证功能。
提供URL模式和HTTP方法支持。
内置简单的依赖注入机制。
支持版本控制。

ASP.NET Web API的工作原理

一个ASP.NET Core Web API通常由一个或多个从ControllerBase派生的控制器类组成。ControllerBase类提供了许多用于处理HTTP请求的方法和属性。

如上图所示，客户端通过API发出HTTP请求，控制器负责识别调用并与数据访问层交互。在这个过程中，模型会返回一个包含JSON对象的HTTP响应，从而实现客户端与数据的桥接。

接下来，我们将通过创建一个API实例，进一步了解它的实际工作方式。

创建一个ASP.NET Core 5 Web API

要创建一个ASP.NET Core 5 Web API应用程序，您需要以下工具：

.NET SDK：开发.NET平台所需的工具包，建议使用.NET 5.0版本。
Visual Studio 2019：推荐使用免费的社区版，它包含创建、测试和部署Web API的所有功能。

创建步骤

打开Visual Studio 2019，点击“创建新项目”。
选择“ASP.NET Core Web API”选项并点击“下一步”。
输入项目名称（例如“MyReadingList.WebAPI”）和解决方案名称（例如“MyReadingList”），然后点击“下一步”。
在“目标框架”中选择“.NET 5.0”，然后点击“创建”。

默认情况下，新创建的API包含运行所需的基础结构和一个示例控制器。启动应用程序后，可以通过以下URL访问：

https://localhost:44345/swagger/index.html

接下来，我们将创建一个自定义的API示例：阅读列表，并添加我们最喜欢的书籍。

创建数据库上下文

上下文类负责与数据对象交互，管理实体对象的生命周期，包括从数据库填充数据、跟踪更改并将数据持久化到数据库。

在本项目中，我们将使用SQLite数据库，它是一种小型、快速、自包含的SQL数据库引擎。

安装所需软件包

通过NuGet包管理器安装以下软件包：

Microsoft.EntityFrameworkCore 版本=5.0.9
Microsoft.EntityFrameworkCore.Design 版本=5.0.9
Microsoft.EntityFrameworkCore.Sqlite 版本=5.0.9
Microsoft.EntityFrameworkCore.Sqlite.Design 版本=1.1.6
Microsoft.EntityFrameworkCore.Tools 版本=5.0.9

在项目的Models文件夹中创建一个名为BookContext的类，并定义数据库上下文。

创建SQLite连接字符串

在appsettings.json文件中添加一个连接字符串，用于连接名为“ReadingList.db”的数据库。

通过依赖注入注册上下文

ASP.NET Core默认支持依赖注入。打开Startup.cs文件，在ConfigureServices方法中注册上下文类。

创建数据库

使用迁移功能从模型生成数据库。迁移允许您对模型进行更改并将这些更改应用到数据库架构。

运行以下命令以支持迁移并创建初始表集：

dotnet ef migrations add InitialCreate
dotnet ef database update

如果遇到与EntityFramework版本相关的错误，可以运行以下命令更新工具：

dotnet tool update --global dotnet-ef --version 5.0.9

成功后，您将在项目根目录下看到生成的ReadingList.db文件。

创建控制器

为了在数据库中执行CRUD操作，我们需要创建一个控制器。按照以下步骤操作：

右键单击“Controllers”文件夹，选择“添加” → “控制器”。
选择“MVC控制器-空”，点击“添加”。
将生成的文件命名为BooksController，并实现CRUD操作的方法。

使用Fiddler测试API

通过Fiddler工具测试API的CRUD操作：

创建记录

通过API的Create方法将书籍添加到数据库中。使用SQLite查看器验证记录是否成功插入。

获取所有书籍

使用GET方法获取所有书籍。

更新记录

通过Update方法修改书籍信息。

删除记录

使用DELETE方法删除指定的书籍。

总结

本文介绍了如何使用ASP.NET Core创建Web API，包括项目创建、数据库配置以及CRUD操作的实现。通过这些步骤，您可以轻松创建一个功能强大的API，并将其用于各种应用场景。

在下一篇文章中，我们将开发一个前端应用程序，并与API集成以显示记录。敬请期待！

原文链接: https://www.telerik.com/blogs/aspnet-core-beginners-web-apis