在前端开发中，我们常常需要通过后端 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。在终端中输入以下命令：
pip install fastapi
安装完毕之后，可以通过以下代码来创建一个 Hello World 的 API 服务：
from fastapi import FastAPI
app = FastAPI()
@app.get("/")
async def root():
return {"message": "Hello World"}在上面的代码中，我们首先导入了 fastapi 库，然后创建了一个 app 实例。接着，我们定义了一个根路由（/）的 GET 方法 root，用于返回一个 JSON 结构的消息。
现在，我们使用以下命令启动这个服务：
uvicorn main:app --reload
然后在浏览器中输入地址 http://localhost:8000/，应该能够看到以下内容：
{"message": "Hello World"}至此，我们已经成功地创建了第一个 fast-api 服务。接下来，我们要深入学习 fast-api 的一些功能，并在前端中如何调用它。
路由和参数
在 fast-api 中，我们可以使用 @app.get、@app.post、@app.put、@app.delete 等装饰器来定义不同的路由和对应的 HTTP 方法。同时，我们也可以在路由中定义参数，比如路径参数、查询参数、请求体等等。
以下是一个示例代码，它定义了一个路径参数和一个查询参数，并返回它们的值：
from typing import Optional
from fastapi import FastAPI
app = FastAPI()
@app.get("/{item_id}")
async def read_item(item_id: int, q: Optional[str] = None):
return {"item_id": item_id, "q": q}在这个路由中，我们用花括号（{}）来定义路径参数，比如 {item_id}。而查询参数则通过函数中的参数来指定，比如 q: Optional[str] = None，其中 Optional 表示这个参数可以为空，str 表示数据类型为字符串。
如果我们访问地址 http://localhost:8000/42?q=test，则会看到以下 JSON 结构的响应：
{
"item_id": 42,
"q": "test"
}数据验证
在前面提到的示例中，我们并没有对输入的参数进行数据验证。但是，在实际开发中，数据验证是非常重要的，可以帮助我们避免一些不必要的错误。
在 fast-api 中，我们可以使用 pydantic 库来实现数据验证。比如，我们可以定义一个 Item 类来描述一个商品，代码如下：
-- -------------------- ---- -------
---- ------ ------ ----
---- -------- ------ ---------
----- ----------------
----- ---
------------ --- - ----
------ -----
---- ----- - ----
----- --------- - --在这个类中，我们定义了 5 个属性，其中包括必填的 name、price 以及可选的 description、tax 和 tags。同时，我们通过 List[str] 来指定 tags 的数据类型是字符串列表。
在路由中，我们可以通过函数的参数来接收 Item 对象，并对其进行验证。如果验证失败，fast-api 会自动返回错误响应。
以下是一个示例代码，它接收一个 Item 对象，并返回提交的对象信息：
@app.post("/items/")
async def create_item(item: Item):
return item如果我们使用以下 JSON 数据来请求：
{
"name": "item1",
"price": 10.0,
"tax": 1.0,
}则会得到以下 JSON 响应：
-- -------------------- ---- -------
-
--------- -
-
------ -
-------
------
--
------ ------ ----------
------- ---------------------
-
-
-在这个响应中，我们可以看到在数据验证中出现的错误信息。fast-api 通过 detail 属性来描述验证错误的具体信息。
数据库支持
fast-api 提供了对 SQLAlchemy 数据库的支持。我们可以使用 SQLAlchemy 库来连接数据库，并使用 async 关键字来实现异步操作。
以下是一个示例代码，它定义了一个 Note 数据表，用于存储笔记信息：
-- -------------------- ---- -------
---- ---------- ------ ------- -------- ------
---- ---------------------- ------ -------------------
---- -------------- ------ ----------------- ------------
---- - ------------------
----- -----------
------------- - -------
-- - --------------- ----------------- -----------
----- - -------------- -----------
------- - --------------在这个类中，我们使用 SQLAlchemy 的 Column、declarative_base 等类来定义数据表、列等信息。
接着，我们可以使用 create_async_engine 函数来连接数据库，并使用 sessionmaker 函数来创建异步数据库会话。以下代码连接 SQLite 数据库：
SQLALCHEMY_DATABASE_URL = "sqlite+aiosqlite:///./test.db" engine = create_async_engine(SQLALCHEMY_DATABASE_URL, echo=True) async_session = sessionmaker(bind=engine, class_=AsyncSession)
在路由中，我们可以通过 async with .. 来实现异步数据库操作。以下是一个示例代码，它保存提交的笔记信息到数据库中：
@app.post("/notes/")
async def create_note(note: NoteCreate):
db_note = Note(**note.dict())
async with async_session() as session:
session.add(db_note)
await session.commit()
await session.refresh(db_note)
return db_note在这个路由中，我们使用 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 中。
const token = localStorage.getItem('token')
if (token) {
axios.defaults.headers.common['Authorization'] = 'Bearer ' + token
}同时，我们可以使用 Vuex 或者其他状态管理库来管理笔记列表的状态。
总结
在这篇文章中，我们介绍了如何使用 fast-api 来创建一个 RESTful API 服务，并实现了一些关键的功能，比如路由和参数、数据验证、数据库支持、JWT 认证等。同时，我们还介绍了如何在前端中使用 HTTP 请求库来调用 API 接口，从而展示 API 返回的数据。希望这篇文章对你有所启发，如果你有任何问题或建议，请在评论区留言！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/110349