如何使用 ASP.NET Core Web API 开发 RESTful API

阅读时长 6 分钟读完

什么是 RESTful API?

REST(Representational State Transfer)是一种 Web 服务架构风格,它基于以下约束条件:

  • 使用 URI(统一资源标识符)来标识资源
  • 使用 HTTP 方法(GET、POST、PUT、DELETE)来操作资源
  • 传输的数据格式为 JSON、XML 或其他内容协商技术确定的格式
  • 无状态通信

RESTful API 是基于 REST 架构风格的 Web API,它使用 HTTP 协议中的 GET、POST、PUT、DELETE 方法来操作资源,以 JSON、XML 等数据格式进行数据交互。

ASP.NET Core Web API

ASP.NET Core 是一框架,可用于构建 Web 应用程序和 Web 服务。ASP.NET Core Web API 就是 ASP.NET Core 的一部分,它为构建 RESTful API 提供了强大的支持。

开始编写 RESTful API

在开始编写 RESTful API 之前,需要进行一些配置和准备工作。

安装 Visual Studio

首先,需要安装 Visual Studio 2019 或更高版本。可以从 Microsoft 官网免费下载并安装。

创建项目

在 Visual Studio 中,创建一个新的 ASP.NET Core 项目。选择“Web 应用程序(.NET Core)”,并设置一个合适的项目名称。

配置 Web API

打开创建的项目,找到 Startup.cs 文件,编辑 ConfigureServicesConfigure 方法。

ConfigureServices 方法

ConfigureServices 方法中,需要进行以下配置:

这个方法会将所有控制器添加到应用程序的服务容器中。

Configure 方法

Configure 方法中,需要进行以下配置:

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

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

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

这个方法会配置路由并将控制器映射到端点。

创建控制器

在项目中创建一个控制器,继承自 ControllerBase,然后添加一些方法来执行 CRUD 操作。

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

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

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

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

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

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

这个控制器有五个方法:

  • Get():获取所有资源
  • Get(id):获取指定 id 的资源
  • Post(value):创建新资源
  • Put(id, value):更新指定 id 的资源
  • Delete(id):删除指定 id 的资源

测试 RESTful API

通过浏览器或任何支持 HTTP 请求的工具,可以发送 GET、POST、PUT、DELETE 请求来测试 RESTful API。

例如,对于上面创建的控制器,可以使用以下请求测试:

  • GET 请求:http://localhost:5000/api/my
  • POST 请求:http://localhost:5000/api/my,请求体为 JSON 数据
  • PUT 请求:http://localhost:5000/api/my/{id},请求体为 JSON 数据
  • DELETE 请求:http://localhost:5000/api/my/{id}

总结

ASP.NET Core Web API 是一个强大的框架,可用于创建 RESTful API。通过本文,你已经了解了如何使用 ASP.NET Core Web API 创建 RESTful API,包括路由配置、控制器创建、方法实现和测试 API。接下来,你可以通过编写更多的 API 来熟悉 RESTful API 的更多特性,为构建更好的 Web 服务应用做好准备。

示例代码

示例代码可从以下链接获取:https://github.com/microsoft/aspnet-api-versioning/tree/master/samples/aspnetcore/SwaggerSamples

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

纠错
反馈