Web API快速入门：搭建一个连接SQL Server数据库的API

2022-11-15 01:58:39

搭建基于 ASP.NET Core 和 SQL Server 的 RESTful Web API

简介

在当今数字时代，开发 RESTful Web API 变得轻而易举，归功于 Microsoft 提供的方便易用的 API 框架。本文将一步步指导你构建一个简单的 Web API，并将其与 SQL Server 数据库相连。

创建 Web API 项目

在 Visual Studio 中使用 ASP.NET Core 构建 API。选择 API 项目模板，它将提供一个基本的 API 项目结构。在 Controllers 文件夹中，添加一个名为 ProductsController 的控制器，该控制器负责处理 HTTP 请求。

处理 HTTP 请求

在 ProductsController 类中添加代码来处理 GET 请求。GetProducts() 方法检索所有产品，而 GetProduct(int id) 方法检索具有指定 ID 的产品。

public class ProductsController : ApiController
{
    // GET: api/Products
    public IEnumerable<Product> GetProducts() { ... }

    // GET: api/Products/5
    public Product GetProduct(int id) { ... }
}

连接 SQL Server 数据库

使用 Entity Framework Core 将 API 连接到 SQL Server 数据库。在项目中安装 Microsoft.EntityFrameworkCore.SqlServer NuGet 包。添加 AdventureWorks2012Entities 类来与数据库交互。

public class AdventureWorks2012Entities : DbContext
{
    public DbSet<Product> Products { get; set; }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder) { ... }
}

运行 API

运行 API 并测试其功能。使用工具（例如 Postman）发送 HTTP GET 请求来检索产品。你应该会收到一个响应，其中包含来自数据库的 JSON 数据。

进阶步骤

除了基本 CRUD 操作外，你还可以扩展 API 以支持其他功能，例如：