使用.NET Core 创建 RESTful API-JavaScript中文网-JavaScript教程资源分享门户

在现代化的 web 开发中，RESTful API 已经成为了一种最流行且通用的设计风格。它能够提供高效且灵活的接口，为前端和后端的解耦合和分离量身定制。本文将介绍如何使用 .NET Core 创建 RESTful API。

概述

.NET Core 是一个跨平台、开源、高性能的编程框架，由微软公司开发和维护。它支持多种编程语言，包括 C#、F#、Visual Basic 等。在 .NET Core 中，我们可以使用 ASP.NET Core 来创建 RESTful API。

RESTful API 标准通常包括以下特点：

使用 HTTP 动词进行操作（GET、POST、PUT、DELETE 等）
基于 URL 路径进行资源访问
支持多种媒体格式（JSON、XML 等）
无状态设计，客户端和服务器之间相互独立
使用状态码表示请求结果和错误信息

在 .NET Core 中，我们可以使用 ASP.NET Core 提供的功能和工具轻松实现 RESTful API。

创建项目和控制器

第一步，打开 Visual Studio，并创建一个 ASP.NET Core Web 应用程序。在创建时选择 API 类型。这将创建包含一个默认控制器的基本项目。

在默认控制器中，可以使用以下代码来创建一个基础 API：

-- -------------------- ---- -------
---------------------------
---------------
------ ----- ---------------- - --------------
-
    -- --- ----------
    ---------
    ------ --------------------------------- -----
    -
        ------ --- -------- - --------- -------- --
    -

    -- --- ------------
    -----------------
    ------ -------------------- ------- ---
    -
        ------ --------
    -

    -- ---- ----------
    ----------
    ------ ---- --------------- ------ ------
    -
    -

    -- --- ------------
    -----------------
    ------ ---- ------- --- ---------- ------ ------
    -
    -

    -- ------ ------------
    --------------------
    ------ ---- ---------- ---
    -
    -
-展开代码

在上面的代码中，使用了 [ApiController] 属性和标记方式，将控制器作为 API 控制器。这些标记将自动设置 API 行为的类型，如请求验证、异常处理以及其他功能。

使用 Entity Framework Core

在 .NET Core 中，可以使用 Entity Framework Core 作为 ORM 框架，用于与数据库进行交互的行为。在本例中，我们将使用 Entity Framework Core 用于数据访问。我们将从创建数据库框架并通过 Entity Framework Core 获取数据开始。

在 Visual Studio 解决方案资源管理器中，右键单击项目并选择添加 -> 新建项 -> 数据 -> 数据库。下面是创建数据库模型的方法：

public class TodoItem
{
    public long Id { get; set; }
    public string Name { get; set; }
    public bool IsComplete { get; set; }
}

接下来，创建一个上下文类，它将表示数据模型的更高级别表示。使用 Entity Framework Core 时，通常将这个类称为上下文。

-- -------------------- ---- -------
------ ----- ----------- - ---------
-
    ------ ----------------------------------------- --------
        - -------------
    -
    -

    ------ --------------- --------- - ---- ---- -
-展开代码

最后，需要在 Startup.cs 文件中配置数据库上下文。代码如下：

public void ConfigureServices(IServiceCollection services)
{
    services.AddDbContext<TodoContext>(opt =>
    opt.UseInMemoryDatabase("TodoList"));
    services.AddControllers();
}

我们当前使用的是内存数据库，旨在暂时演示如何将 Entity Framework Core 集成到应用程序中。在实际项目中，可以使用 Microsoft SQL Server 或其他支持的数据库。

创建 API 行为

获取所有 Todo

[HttpGet]
public async Task<ActionResult<IEnumerable<TodoItem>>> GetAll()
{
    return await _context.TodoItems.ToListAsync();
}

获取单个 Todo

-- -------------------- ---- -------
-----------------
------ ----- ---------------------------- ------------ ---
-
    --- -------- - ----- ---------------------------------

    -- --------- -- -----
    -
        ------ -----------
    -

    ------ ---------
-展开代码

创建 Todo

[HttpPost]
public async Task<ActionResult<TodoItem>> Create(TodoItem todoItem)
{
    _context.TodoItems.Add(todoItem);
    await _context.SaveChangesAsync();

    return CreatedAtAction(nameof(GetById), new { id = todoItem.Id }, todoItem);
}

更新 Todo

-- -------------------- ---- -------
-----------------
------ ----- ------------------ ----------- --- -------- ---------
-
    -- --- -- ------------
    -
        ------ -------------
    -

    ------------------------------ - ---------------------
    ----- ----------------------------

    ------ ------------
-展开代码

删除 Todo

-- -------------------- ---- -------
--------------------
------ ----- ------------------ ----------- ---
-
    --- -------- - ----- ---------------------------------

    -- --------- -- -----
    -
        ------ -----------
    -

    ------------------------------------
    ----- ----------------------------

    ------ ------------
-展开代码

总结

在本文中，我们介绍了如何使用 .NET Core 创建 RESTful API。您了解了如何使用 ASP.NET Core 框架，以及 Entity Framework Core 和内存数据库集成，以及如何创建基本 API 行为。学习这些技术，可以帮助您创建一个高效的、可靠的、具有 RESTful API 的 web 应用程序。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/652a40077d4982a6ebc948dc

使用.NET Core 创建 RESTful API

概述