如何使用 ASP.NET Core 构建 RESTful API

前言

RESTful API 是一种常见的 Web API 设计风格，它使用 HTTP 协议进行通信，通过 HTTP 动词（GET、POST、PUT、DELETE 等）对资源进行操作，返回 JSON 或 XML 格式的数据。ASP.NET Core 是微软推出的跨平台的开源 Web 开发框架，它提供了丰富的功能和工具，可以轻松地构建 RESTful API。

本文将介绍如何使用 ASP.NET Core 构建 RESTful API，包括 API 的设计原则、路由配置、数据序列化、异常处理、身份验证和授权等方面。通过本文的学习，读者将能够掌握 ASP.NET Core 构建 RESTful API 的基本技能，为实际开发提供指导和参考。

API 的设计原则

在设计 RESTful API 时，需要遵循一些基本的设计原则，包括：

  • 使用 HTTP 动词对资源进行操作，如 GET、POST、PUT、DELETE 等。
  • 使用 URI（统一资源标识符）表示资源，如 /api/users。
  • 使用 HTTP 状态码表示操作结果，如 200 表示成功、400 表示请求错误、401 表示未授权、404 表示资源不存在等。
  • 使用 JSON 或 XML 格式的数据进行交互，可以使用 ASP.NET Core 内置的数据序列化工具进行转换。
  • 使用版本控制管理 API 的版本，可以使用 URI 或请求头等方式进行控制。

路由配置

在 ASP.NET Core 中，可以通过路由配置来定义 API 的 URI 和操作方法的映射关系。可以使用以下方式进行路由配置：

  • 在 Startup.cs 文件的 ConfigureServices 方法中添加 MVC 服务：
------ ---- ------------------------------------ ---------
-
    ------------------
-
  • 在 Startup.cs 文件的 Configure 方法中添加路由配置：
------ ---- ----------------------------- ---- ------------------- ----
-
    -----------------

    -------------------------- --
    -
        ---------------------------
    ---
-
  • 在控制器类中添加路由属性和操作方法：
---------------------------
---------------
------ ----- --------------- - --------------
-
    ---------
    ------ ------------- -----
    -
        -- ----- ------
    -

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

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

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

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

在上面的代码中，使用 [Route] 属性定义了控制器的 URI，使用 [HttpGet]、[HttpPost]、[HttpPut]、[HttpDelete] 等属性定义了操作方法的 HTTP 动词和 URI。当请求进入控制器后，ASP.NET Core 将自动根据 URI 和 HTTP 动词来选择对应的操作方法进行处理。

数据序列化

在 RESTful API 中，数据的交互通常使用 JSON 或 XML 格式的数据。ASP.NET Core 提供了内置的数据序列化工具，可以方便地将对象序列化为 JSON 或 XML 格式的数据。可以使用以下方式进行数据序列化：

  • 在 Startup.cs 文件的 ConfigureServices 方法中添加 JSON 和 XML 序列化服务：
------ ---- ------------------------------------ ---------
-
    -----------------
        ----------------------- --
        -
            -------------------------------------------------- - -----
            ------------------------------------------------- - -----
        --
        ------------------------------
-
  • 在操作方法中返回对象：
---------
------ ------------- -----
-
    --- ----- - ------------------------
    ------ ----------
-

在上面的代码中，使用 Ok 方法返回对象，ASP.NET Core 将自动使用 JSON 或 XML 格式的数据进行序列化，并设置 Content-Type 头为 application/json 或 application/xml。

异常处理

在 RESTful API 中，异常处理是非常重要的一部分，它可以帮助我们更好地处理错误和异常情况，提高 API 的健壮性和可靠性。ASP.NET Core 提供了内置的异常处理机制，可以方便地处理各种异常情况。可以使用以下方式进行异常处理：

  • 在 Startup.cs 文件的 Configure 方法中添加全局异常处理中间件：
------ ---- ----------------------------- ---- ------------------- ----
-
    -----------------

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

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

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

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

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

在上面的代码中，使用 UseExceptionHandler 方法添加全局异常处理中间件。当 API 抛出异常时，ASP.NET Core 将自动捕获异常并调用中间件进行处理。在中间件中，可以根据异常类型设置 HTTP 状态码和错误信息，并将其序列化为 JSON 格式的数据返回给客户端。

身份验证和授权

在 RESTful API 中，身份验证和授权是非常重要的一部分，它可以帮助我们保护 API 的安全性和隐私性，防止未授权的访问和操作。ASP.NET Core 提供了丰富的身份验证和授权机制，可以方便地进行身份验证和授权。可以使用以下方式进行身份验证和授权：

  • 在 Startup.cs 文件的 ConfigureServices 方法中添加身份验证服务：
------ ---- ------------------------------------ ---------
-
    ---------------------------------- --
    -
        --------------------- - ---------------------------------------
    --
    --------------------- --
    -
        --------------------------------- - --- -------------------------
        -
            -------------- - -----
            ---------------- - -----
            ---------------- - -----
            ------------------------ - -----
            ----------- - ----------------------------
            ------------- - ------------------------------
            ---------------- - --- ----------------------------------------------------------------------------
        --
    ---

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

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

在上面的代码中，使用 AddAuthentication 方法添加身份验证服务，并设置默认的身份验证方案为 JwtBearerDefaults.AuthenticationScheme。使用 AddJwtBearer 方法添加 JWT 身份验证方案，并设置 TokenValidationParameters 参数来验证 JWT 的有效性和合法性。使用 AddAuthorization 方法添加授权服务，并设置授权策略，可以根据角色、声明等进行授权。

  • 在 Startup.cs 文件的 Configure 方法中添加身份验证和授权中间件：
------ ---- ----------------------------- ---- ------------------- ----
-
    -----------------

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

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

在上面的代码中，使用 UseAuthentication 和 UseAuthorization 方法添加身份验证和授权中间件。当 API 接收到请求时，ASP.NET Core 将自动进行身份验证和授权，根据授权策略来判断是否允许访问和操作。

示例代码

完整的 ASP.NET Core RESTful API 示例代码如下：

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

总结

本文介绍了如何使用 ASP.NET Core 构建 RESTful API，包括 API 的设计原则、路由配置、数据序列化、异常处理、身份验证和授权等方面。通过本文的学习，读者可以掌握 ASP.NET Core 构建 RESTful API 的基本技能，为实际开发提供指导和参考。当然，实际的开发中还有很多细节和问题需要注意，需要结合具体的业务场景和需求进行调整和优化。

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/662b8824d3423812e491b603

阅读全文

猜你喜欢

  • GraphQL：用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言，它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据，避免了传统...

    2 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events？ Server-sent Events（简称 SSE）是一种基于 HTTP 的服务器推送技术，它可以让服务器向客户端发送事件流，客户端通过监听这个事件流来...

    2 个月前
  • ECMAScript 2020（ES11）中的新特性：BigInt 转换

    在 ECMAScript 2020（ES11）中，新增了一种数据类型：BigInt。它是一种可以表示任意大整数的数据类型，可以用来解决 JavaScript 中整数运算的精度问题。

    2 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式，消除不同浏览器之间的差异，从而实现更加一致的样式效果的技术手段。在前端开发中，使用 CSS Reset 可以让我们更...

    2 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中，引入了 class 关键字，使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间，有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系，并提供一...

    2 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时，表单数据的处理是非常常见的需求。然而，由于 React 的单向数据流和组件化特性，传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具，可以帮助...

    2 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展，高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库，也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略，并且会提...

    2 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中，图片适配是一个比较棘手的问题。如果不加以处理，可能会导致图片在不同设备上显示不佳，影响用户体验。本文将介绍响应式设计中的图片适配问题，并提供解决方案。

    2 个月前
  • 解析 TypeScript 中 encapsulation（封装）的实现方式

    解析 TypeScript 中 encapsulation（封装）的实现方式 在 TypeScript 中，封装（encapsulation）是一种重要的面向对象编程的特性。

    2 个月前
  • PM2 崩溃处理：如何避免由于 PM2 进程奔溃导致应用崩溃？

    在前端开发中，我们经常使用 PM2 进行进程管理和部署。但是，当 PM2 进程崩溃时，应用也会跟着崩溃。如何避免这种情况的发生？本文将介绍 PM2 崩溃处理的方法和技巧，帮助您更好地管理和部署应用。

    2 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境，它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时，安全性是非常重要的。

    2 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准，其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法，分别是：扩展运算符、剩余运算符...

    2 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时，我们经常需要使用 Enzyme 来测试组件。然而，当我们测试涉及到动画的组件时，我们可能会遇到一些问题：动画无法渲染，导致测试失败。

    2 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展，单页应用（Single Page Application，SPA）已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面，提供了更快速、更流畅的用户体...

    2 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中，ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    2 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中，Promise.all 是一个非常常用的功能，它可以让我们在多个异步操作完成后再执行一些操作，这个功能在实际开发中非常实用。

    2 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中，经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具，它提供了一种方便的方式来操作 MongoDB ...

    2 个月前
  • 在使用 lit-element 的时候，如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候，我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而，Shadow DOM 的封闭性也带来了一些挑战，其中之一就是变量传递问题。

    2 个月前
  • Tailwind CSS 如何实现动态换肤？

    随着互联网的发展，越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验，还可以让用户在不同的环境下选择适合自己的主题，增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    2 个月前
  • 如何在 Less 中使用字符串操作函数？

    在前端开发中，样式表是不可或缺的一部分。而 Less 是一种动态样式语言，它是 CSS 的一种扩展。在 Less 中，我们可以使用字符串操作函数来处理字符串，这些函数可以帮助我们更加方便地操作字符串，...

    2 个月前

相关推荐

    暂无文章