使用ASP.NET Core创建RESTful API：全面指南

RESTful API 是现代 Web 应用程序和移动应用程序之间数据交换的核心技术之一。而 ASP.NET Core 是一个功能强大的开源跨平台框架，特别适合用于构建 RESTful API。在本文中，我们将详细介绍如何使用 ASP.NET Core 创建 RESTful API，包括基础知识和高级技术，帮助您构建健壮且可扩展的 API。

什么是 API 和 RESTful API？

API（应用程序编程接口）

API 是一种用于在两个或多个软件系统之间进行通信的接口。通过 API，一个系统可以将其功能开放给其他系统，从而实现数据交换和功能共享。

RESTful API（表述性状态传递 API）

RESTful API 是一种基于 REST 架构风格的 API 类型。REST 架构遵循以下六个核心原则：

资源定义：每个资源都由唯一的 URI（统一资源标识符）标识。
无状态性：每个请求都包含完成该请求所需的所有信息。
客户端-服务器架构：客户端和服务器之间分离，独立开发。
统一接口：通过标准化的接口进行交互。
缓存支持：允许客户端缓存响应数据。
分层系统：支持通过中间层（如负载均衡器）进行交互。

为什么选择 ASP.NET Core？

ASP.NET Core 是微软开发的开源跨平台 Web 开发框架。它支持构建网站、Web API、移动应用程序以及物联网设备应用。以下是 ASP.NET Core 的一些关键特性：

跨平台支持：可在 Windows、macOS 和 Linux 上运行。
高性能：针对高并发场景进行了优化。
模块化架构：支持按需加载组件。
内置依赖注入：简化了服务的注册和使用。

使用 ASP.NET Core 创建 RESTful API 的步骤

第一步：创建新项目

打开 Visual Studio。
选择“创建新项目”。
选择“ASP.NET Core Web API”模板并完成项目创建。

第二步：配置项目

打开 Startup.cs 文件。
配置服务和中间件，例如添加数据库支持和依赖注入。

使用实体框架核心创建数据库模型

什么是实体框架核心？

实体框架核心（Entity Framework Core）是微软开发的开源 ORM（对象关系映射）框架。它简化了与数据库的交互，使开发者可以通过操作对象来完成数据库操作，而无需编写复杂的 SQL 查询。

创建数据库模型的步骤

创建模型类：
在项目中创建一个名为 Models 的文件夹，并添加一个名为 Product.cs 的类：

public class Product
{
   public int Id { get; set; }
   public string Name { get; set; }
   public decimal Price { get; set; }
   public int Stock { get; set; }
}

创建数据库上下文类：
在 Data 文件夹中创建一个名为 ApplicationDbContext.cs 的类：

public class ApplicationDbContext : DbContext
{
   public ApplicationDbContext(DbContextOptions options) : base(options) { }
   public DbSet Products { get; set; }
}

配置数据库连接：
在 appsettings.json 文件中添加数据库连接字符串：

{
   "ConnectionStrings": {
       "DefaultConnection": "Server=(localdb)\mssqllocaldb;Database=MyDatabase;Trusted_Connection=True;MultipleActiveResultSets=True"
   }
}

注册数据库上下文：
在 Startup.cs 文件中添加以下代码：

public void ConfigureServices(IServiceCollection services)
{
   services.AddDbContext(options =>
       options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")));
}

使用设计模式优化 API

存储库模式

存储库模式通过抽象数据库交互逻辑，使代码更容易维护和扩展。

实现存储库模式的步骤

创建一个名为 IRepository.cs 的接口：

public interface IRepository where T : class
{
   Task<IEnumerable> GetAllAsync();
   Task GetByIdAsync(int id);
   Task AddAsync(T entity);
   Task UpdateAsync(T entity);
   Task DeleteAsync(int id);
}

创建一个名为 Repository.cs 的类，实现上述接口：

public class Repository : IRepository where T : class
{
   private readonly ApplicationDbContext _context;

   public Repository(ApplicationDbContext context)
   {
       _context = context;
   }

   public async Task<IEnumerable> GetAllAsync()
   {
       return await _context.Set().ToListAsync();
   }

   public async Task GetByIdAsync(int id)
   {
       return await _context.Set().FindAsync(id);
   }

   public async Task AddAsync(T entity)
   {
       await _context.Set().AddAsync(entity);
       await _context.SaveChangesAsync();
   }

   public async Task UpdateAsync(T entity)
   {
       _context.Set().Update(entity);
       await _context.SaveChangesAsync();
   }

   public async Task DeleteAsync(int id)
   {
       var entity = await _context.Set().FindAsync(id);
       _context.Set().Remove(entity);
       await _context.SaveChangesAsync();
   }
}

在 Startup.cs 文件中注册存储库：

public void ConfigureServices(IServiceCollection services)
{
   services.AddScoped(typeof(IRepository), typeof(Repository));
}

工作单元模式

工作单元模式将多个数据库操作组合到一个事务中，确保数据一致性。

实现工作单元模式的步骤

创建一个名为 IUnitOfWork.cs 的接口：

public interface IUnitOfWork : IDisposable
{
   IRepository Products { get; }
   Task CompleteAsync();
}

创建一个实现该接口的类：

public class UnitOfWork : IUnitOfWork
{
   private readonly ApplicationDbContext _context;
   public IRepository Products { get; }

   public UnitOfWork(ApplicationDbContext context, IRepository products)
   {
       _context = context;
       Products = products;
   }

   public async Task CompleteAsync()
   {
       await _context.SaveChangesAsync();
   }

   public void Dispose()
   {
       _context.Dispose();
   }
}

在 Startup.cs 文件中注册工作单元：

public void ConfigureServices(IServiceCollection services)
{
   services.AddScoped();
}

总结

通过本文的介绍，我们学习了如何使用 ASP.NET Core 创建 RESTful API 的基础知识和高级技术，包括如何配置项目、使用实体框架核心创建数据库模型，以及通过存储库模式和工作单元模式优化 API 的设计。掌握这些技能后，您将能够构建高效、模块化且易于维护的 API。

原文链接: https://www.modsoft.com.tr/blog/software-development/creating-restful-api-asp-net-core-comprehensive-guide/