npm 包 fast-api 使用教程

在前端开发中，我们常常需要通过后端 API 来获取数据或者与后端交互。本文将介绍如何使用 npm 包 fast-api 来快速创建一个 RESTful API 服务，以及如何在前端中使用它。

fast-api 是什么？

fast-api 是一个基于 Python 的现代 Web 框架，它的特点是快速、易用、安全和易于扩展。同时，它还提供了基于 OpenAPI(Swagger) 的自动生成文档，可以帮助我们快速实现后端 API 服务。

同时，fast-api 具有异步 IO 的能力，基于 Starlette 框架，支持 HTTP/2、WebSocket 等协议，同时还提供了基于 pydantic 的数据验证和基于 SQLAlchemy 的数据库支持等多种功能，非常适合用于构建高性能的 RESTful API 服务。

安装和使用 fast-api

要使用 fast-api，首先需要安装它。可以通过 pip 命令来安装 fast-api。在终端中输入以下命令：

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

安装完毕之后，可以通过以下代码来创建一个 Hello World 的 API 服务：

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

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

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

在上面的代码中，我们首先导入了 fastapi 库，然后创建了一个 app 实例。接着，我们定义了一个根路由（/）的 GET 方法 root，用于返回一个 JSON 结构的消息。

现在，我们使用以下命令启动这个服务：

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

然后在浏览器中输入地址 http://localhost:8000/，应该能够看到以下内容：

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

至此，我们已经成功地创建了第一个 fast-api 服务。接下来，我们要深入学习 fast-api 的一些功能，并在前端中如何调用它。

路由和参数

在 fast-api 中，我们可以使用 @app.get、@app.post、@app.put、@app.delete 等装饰器来定义不同的路由和对应的 HTTP 方法。同时，我们也可以在路由中定义参数，比如路径参数、查询参数、请求体等等。

以下是一个示例代码，它定义了一个路径参数和一个查询参数，并返回它们的值：

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

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

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

在这个路由中，我们用花括号（{}）来定义路径参数，比如 {item_id}。而查询参数则通过函数中的参数来指定，比如 q: Optional[str] = None，其中 Optional 表示这个参数可以为空，str 表示数据类型为字符串。

如果我们访问地址 http://localhost:8000/42?q=test，则会看到以下 JSON 结构的响应：

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

数据验证

在前面提到的示例中，我们并没有对输入的参数进行数据验证。但是，在实际开发中，数据验证是非常重要的，可以帮助我们避免一些不必要的错误。

在 fast-api 中，我们可以使用 pydantic 库来实现数据验证。比如，我们可以定义一个 Item 类来描述一个商品，代码如下：

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

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

在这个类中，我们定义了 5 个属性，其中包括必填的 name、price 以及可选的 description、tax 和 tags。同时，我们通过 List[str] 来指定 tags 的数据类型是字符串列表。

在路由中，我们可以通过函数的参数来接收 Item 对象，并对其进行验证。如果验证失败，fast-api 会自动返回错误响应。

以下是一个示例代码，它接收一个 Item 对象，并返回提交的对象信息：

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

如果我们使用以下 JSON 数据来请求：

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

则会得到以下 JSON 响应：

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

在这个响应中，我们可以看到在数据验证中出现的错误信息。fast-api 通过 detail 属性来描述验证错误的具体信息。

数据库支持

fast-api 提供了对 SQLAlchemy 数据库的支持。我们可以使用 SQLAlchemy 库来连接数据库，并使用 async 关键字来实现异步操作。

以下是一个示例代码，它定义了一个 Note 数据表，用于存储笔记信息：

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

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

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

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

在这个类中，我们使用 SQLAlchemy 的 Column、declarative_base 等类来定义数据表、列等信息。

接着，我们可以使用 create_async_engine 函数来连接数据库，并使用 sessionmaker 函数来创建异步数据库会话。以下代码连接 SQLite 数据库：

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

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

在路由中，我们可以通过 async with .. 来实现异步数据库操作。以下是一个示例代码，它保存提交的笔记信息到数据库中：

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

在这个路由中，我们使用 NoteCreate 类来接收请求体中的 JSON 数据，并创建一个 Note 对象。然后，我们使用 async_session 来创建异步会话，并将对象添加到会话中，最后返回创建的对象。

JWT 认证

在实际的项目中，我们通常需要通过 JWT 认证来保护我们的 API 服务。在 fast-api 中，我们可以使用 PyJWT 库来实现 JWT 认证，并使用 fast-api 的 Depends 来实现依赖注入。

以下是一个示例代码，它定义了 get_current_user 方法，并使用 JWT 认证来保护添加笔记的接口：

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

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

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

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

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

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

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

在这个代码中，我们使用 OAuth2PasswordBearer 和 OAuth2PasswordRequestForm 来定义 JWT 认证相关的信息。然后，我们定义了一个 get_current_user 方法，并使用 Depends 来实现依赖注入，用于验证当前用户是否已经登录。

最后，我们在添加笔记的路由中使用 current_user 参数来接收当前用户，并通过 author_id 来关联笔记信息和用户信息。

前端中使用 fast-api

在前端中，我们可以使用 Axios 或者其他的 HTTP 请求库来访问 fast-api 提供的接口。以下是一个使用 Axios 的示例代码，它通过获取笔记列表的接口来展示笔记列表：

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

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

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

在这个代码中，我们使用 Axios 来获取笔记的列表。由于笔记列表接口是需要 JWT 认证的，因此我们需要先获取 JWT Token，并将其放到请求 Header 中。

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

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

同时，我们可以使用 Vuex 或者其他状态管理库来管理笔记列表的状态。

总结

在这篇文章中，我们介绍了如何使用 fast-api 来创建一个 RESTful API 服务，并实现了一些关键的功能，比如路由和参数、数据验证、数据库支持、JWT 认证等。同时，我们还介绍了如何在前端中使用 HTTP 请求库来调用 API 接口，从而展示 API 返回的数据。希望这篇文章对你有所启发，如果你有任何问题或建议，请在评论区留言！

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

阅读全文

猜你喜欢

  • GraphQL：用 Connection 优化节点查询

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    1 个月前

相关推荐

    暂无文章