当前位置:   article > 正文

【大模型应用开发-FastAPI框架】(一)FastAPI概述和安装_fastapi 安装

fastapi 安装

一、FastAPI概述

FastAPI 是一个现代、快速(高性能)的 Web 框架,用于构建基于 Python 的 API。它是一个开源项目,基于 Starlette 和 Pydantic 库构建而成,提供了强大的功能和高效的性能。

FastAPI 官网地址:fastapi.tiangolo.com

二、FastAPI 特点

FastAPI 的主要特点包括:

  1. 快速高效:FastAPI 基于异步编程模型(使用 Python 3.7+ 的 async 和 await 关键字),利用了 Python 的异步生态系统,提供出色的性能和吞吐量。
  2. 自动文档生成:FastAPI 可以自动为你的 API 生成交互式文档,支持自动检测请求参数和响应模型,并生成相应的 API 文档。
  3. 数据验证和转换:FastAPI 使用 Pydantic 库,提供了强大的数据验证和转换功能,能够自动处理请求和响应数据的验证、转换和序列化。
  4. 类型提示:FastAPI 基于 Python 的类型提示机制,提供了强类型的请求和响应处理,这样可以减少很多常见的错误,并提供更好的代码提示和可读性。
  5. 安全认证:FastAPI 支持常用的认证方式,如 OAuth2、JWT 等,并提供了对 HTTPS 的支持,可以保护你的 API 通信安全。
  6. 强大的生态系统:FastAPI 可以与众多 Python 生态系统中的工具和库无缝集成,如 SQLAlchemy、Databases、Redis 等。

三、FastAPI安装

下面的步骤将帮助你开始使用 FastAPI 构建一个简单的 Web 应用。


1、安装 FastAPI

在命令行中运行以下命令安装 fastapi,并安装 uvicorn :

 pip install fastapi==0.109.0

你还会需要一个 ASGI 服务器,生产环境可以使用 Uvicorn

pip install uvicorn==0.27.0


2、创建 FastAPI 应用

在你喜欢的 IDE 编辑器中创建一个新的 Python 文件,例如fastapi-demo.py。然后将以下代码复制到文件中:

  1. from fastapi import FastAPI
  2. app = FastAPI()
  3. @app.get("/")
  4. def read_root():
  5. return {"Hello": "World"}

上面的代码创建了一个名为app的 FastAPI 实例,并定义了一个根路由,返回一个简单的 JSON 响应。


3、运行 FastAPI 应用

在命令行中运行以下命令启动 FastAPI 应用:

 uvicorn main:app --reload


FastAPI 将在本地启动一个服务器,并监听默认端口(8000)。

4、浏览器中访问

http://127.0.0.1:8000,看到 {"Hello": "World"} 的响应。

或直接将启动命令放入main.py方法中

  1. from fastapi import FastAPI
  2. import uvicorn
  3. app = FastAPI()
  4. @app.get("/")
  5. def read_root():
  6. return {"Hello": "World"}
  7. if __name__ == '__main__':
  8. uvicorn.run('main:app', host='0.0.0.0', port=8000, reload=True, workers=1)

直接启动main.py方法也可以

四、交互式 API 文档

1、SwaggerUI

现在访问 http://127.0.0.1:8000/docs

你会看到自动生成的交互式 API 文档(由 Swagger UI生成):

2、Redoc UI

可选的 API 文档

访问 http://127.0.0.1:8000/redoc

你会看到另一个自动生成的文档(由 ReDoc 生成):

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/weixin_40725706/article/detail/787344
推荐阅读
相关标签
  

闽ICP备14008679号