如何在.NET Core中创建RESTful API

阅读时长 6 分钟读完

RESTful API是一种基于HTTP协议和Restful架构风格的接口设计模式,它运用在现代前端开发中,并严格遵循HTTP协议的请求方式,实现了客户端与服务器之间资源的交互和数据的传递。在.NET Core环境下,开发者可以使用ASP.NET Core框架,快速创建符合RESTful API标准的Web服务。

本篇文章将介绍如何在.NET Core中创建RESTful API,并提供详细示例。

环境准备

要开始创建RESTful API,您需要做好以下准备:

  • 安装 .NET Core SDK
  • 安装 Visual Studio 或者 Visual Studio Code (推荐)

创建新项目

首先,在Visual Studio 或者 Visual Studio Code中创建一个新的.NET Core项目。

在Visual Studio中,您可以通过选择 File -> New -> Project,并选择 ASP.NET Core Web Application 模板来创建一个项目。您可以选择Web应用程序的类型,例如,Web API或Web应用程序。

在 Visual Studio Code 中,您可以打开终端,并使用命令 dotnet new webapi -n MyApi 来创建一个新的Web API项目,其中 MyApi 是项目的名称。

添加所需的NuGet包

在创建一个新的.NET Core项目之后,您需要添加所需的NuGet包。

在Visual Studio中,您可以在解决方案资源管理器中右键单击项目名称,然后选择 Manage NuGet Packages 选项,以打开 NuGet 管理器。

在 Visual Studio Code 中,您可以通过终端中的命令 dotnet add package,然后添加需要的NuGet包。

对于创建RESTful API,我们需要添加以下NuGet包:

  • Microsoft.AspNetCore.Mvc
  • Microsoft.AspNetCore.Routing

添加控制器

在创建新项目之后,添加一个控制器来处理API的请求。创建的控制器将是RESTful API的唯一入口点。在一个新的.NET Core工程中,控制器的默认存储位置是 /Controllers

在控制器类中添加以下代码来处理一个HTTP GET请求:

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

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

在这个控制器类中,我们为API路径添加了一个 Route 特性。例如,在上面的代码中,Route 特性指定了API的访问地址为 /My

此时,我们可以启动API,并通过 http://localhost:5000/My 访问 API 的根路径,我们将看到以下响应:

实现CRUD操作

创建RESTful API的最常见目的是来实现对某些数据进行 Create、Read、Update 和 Delete 操作。在接下来的示例中,我们将实现以下控制器方法:

  • GET /users:获取所有用户
  • GET /user/{id}:获取单个用户
  • POST /user:添加新用户
  • PUT /user:更新指定用户信息
  • DELETE /user/{id}:删除指定用户
-- -------------------- ---- -------
----- ---------------------------
----- -------------------------

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

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

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

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

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

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

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

在这个样例代码中,我们通过 List<user> 来模拟一个内存数据存储,控制器的每个方法都映射到相应的HTTP操作。

总结

在本文中,我们介绍了如何在.NET Core中创建RESTful API,并阐述了如何使用 Microsoft.AspNetCore.Mvc 和 Microsoft.AspNetCore.Routing 包。我们还实现了一个包含CRUD操作的用户控制器,以示例的方式进行了演示。通过这个demo,我相信您会对如何在.NET Core中创建RESTful API解决方案有更深入的了解。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/647047aa968c7c53b0e692b6

纠错
反馈