FastApi项目搭建

置顶 已于 2023-04-24 17:14:05 修改
阅读量4.5k 收藏 38
点赞数 1
分类专栏： Python 文章标签： fastapi python aerich uvicorn
于 2022-10-19 16:01:28 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_44649870/article/details/125416428
版权

环境

  • Python版本：Python3.8.9
  • 框架：FastApi
      pip install fastapi
  • ORM工具：tortoise-orm
    pip install tortoise-orm
pip install aiomysql
  • 数据库：MySQL
  • 迁移工具：aerich
    pip install aerich
  • 部署工具：uvicorn
    pip install uvicorn
  • 数据校验：Pydantic， FastApi附带安装。
  • 异步任务：celery

项目构建

创建项目所需文件

创建文件夹 fastapi-app，然后创建项目所需文件，创建完成后项目目录格式如下。目前目录创建的都是空白文件，后面再写内容。

.
├── main.py
├── middlewares
│   ├── __init__.py
│   └── auth_middleware.py
├── models
│   ├── __init__.py
│   └── user.py
├── tasks
│   ├── __init__.py
│   └── tasks.py
└── views
    ├── __init__.py
    ├── user.py
    └── login.py

简单启动项目

  1. 在main.py文件中创建fastapi实例。
    from fastapi import FastAPI

def create_app():
    # 创建一个实例
    app = FastAPI()
    return app
  2. 更新main.py，添加一个路由。
    from fastapi import FastAPI

def create_app():
    # 创建一个实例
    app = FastAPI()
    @app.get('/')
    def index():
       return "Hello World"
    return app
app = create_app()
  3. 启动项目：uvicorn main:app --reload。
    (venv) ➜  uvicorn main:app --reload
INFO:     Will watch for changes in these directories: ['/Users/wxy/fastapi-app']
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process [1428] using StatReload
INFO:     Started server process [1430]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
  4. 访问http://127.0.0.1:8000。
    在这里插入图片描述
  5. 访问http://127.0.0.1:8000/docs查看文档。
    在这里插入图片描述

项目拓展

作为实例项目，下面会完成一个用户的创建、登录，虽然只有两个接口，但是其中包括了MySQL的配置和连接、orm工具和迁移工具的使用、中间件的使用等。后面写一个完整的项目其实也就是按照这两个接口修修改改，就不过多赘述了。

更新代码

  1. 更新main.py，配置数据库参数，并且连接数据库。
    import uvicorn
from fastapi import FastAPI
from tortoise.contrib.fastapi import register_tortoise

TORTOISE_ORM_CONFIG = {
    'connections': {
        'default': {
            'engine': 'tortoise.backends.mysql',
            'credentials': {
                'host': 'localhost',
                'port': '3306',
                'user': 'root',
                'password': '12345678',
                'database': 'fastapp',
            }
        },
    },
    'apps': {
        'models': {
            # 数据表对应文件, `aerich.models`是迁移工具生成的数据表
            'models': ['aerich.models', 'models'],
            'default_connection': 'default',
        }
    }
}


def create_app():
    # 创建一个实例
    app = FastAPI()

    # 连接数据库
    register_tortoise(
        app,
        add_exception_handlers=True,
        config=TORTOISE_ORM_CONFIG,
        # 生成模式, 自动创建数据表,
        generate_schemas=False,
    )

    @app.get('/')
    def index():
        return "Hello World"

    return app


app = create_app()
  2. 打开models/user.py新增User的model数据。
    from tortoise import fields, Model


class User(Model):
    """ 创建user表 """
    # pk=True, 设置为主键
    id = fields.IntField(pk=True)
    name = fields.CharField(max_length=64, description="用户名")
    password = fields.CharField(max_length=128, description="登录密码")
    create_at = fields.DatetimeField(auto_now_add=True, description="创建时间")
    modify_at = fields.DatetimeField(auto_now=True, description="更新时间")
  3. 把新创建的User表导入到models/__init__.py中。
    from models.user import User
  4. 打开viewls/user.py新增创建用户接口的路由。
    from fastapi import APIRouter

# 创建一个路由
router = APIRouter(
    # 请求路径
    prefix="/user",
    # 标签, 文档上显示
    tags=["登录"],
)
  5. 更新viewls/user.py文件，添加请求数据的校验和响应数据格式化。
    from fastapi import Body
from pydantic.main import BaseModel
from typing import Optional


class UserRequest(BaseModel):
    """ 创建用户接口数据校验 """
    # default=..., 是指name字段为必填项, 不写default参数也是默认为必填, 这里加上只是为了更清晰
    name: str = Body(default=..., description="用户名")
    password: str = Body(description="登录密码")
    # Optional[str]可选项, default=None可以不填或者是填写None
    email: Optional[str] = Body(default=None, description="邮箱")


class UserResponse(BaseModel):
    """ 创建用户返回数据格式化 """
    name: Optional[str]
    password: Optional[str]
    email: Optional[str]

    class Config:
        # 设置orm_mode=True, 可以在view层直接返回model实例, 并且关联的外键数据也可以直接查出来
        orm_mode = True
  6. 更新viewls/user.py文件，定义创建用户的接口。
    # response_model=UserResponse, 指定响应数据的格式
# response_model_exclude_none=True, 如果返回的字段=None, 不显示该字段
@router.post('/', response_model=UserResponse, response_model_exclude_none=True)
async def create_user(data: UserRequest):
    user = await User.create(
        name=data.name,
        passsword=data.password,
        email=data.email,
    )

    return user
  7. 更新main.py文件，把上面定义的创建路由添加到项目中，在create_app方法最后添加一行app.include_router(user.router)。
    import uvicorn
from fastapi import FastAPI
from tortoise.contrib.fastapi import register_tortoise
from views import user

TORTOISE_ORM_CONFIG = {
    'connections': {
        'default': {
            'engine': 'tortoise.backends.mysql',
            'credentials': {
                'host': 'localhost',
                'port': '3306',
                'user': 'root',
                'password': '12345678',
                'database': 'fastapp',
            }
        },
    },
    'apps': {
        'models': {
            # 数据表对应文件, `aerich.models`是迁移工具生成的数据表
            'models': ['aerich.models', 'models'],
            'default_connection': 'default',
        }
    }
}


def create_app():
    # 创建一个实例
    app = FastAPI()

    # 连接数据库
    register_tortoise(
        app,
        add_exception_handlers=True,
        config=TORTOISE_ORM_CONFIG,
        # 生成模式, 自动创建数据表,
        generate_schemas=False,
    )

    @app.get('/')
    def index():
        return "Hello World"
    # 添加路由
    app.include_router(user.router)
    return app


app = create_app()

到了这里创建用户的接口就算是完成了，但是现在还无法真正的运行起来，如果现在直接运行会提示

tortoise.exceptions.ConfigurationError: default_connection for the model <class 'models.user.User'> cannot be None

这是因为我们创建的User用户表其实还没有在数据库里面创建，需要使用迁移工具更新数据库以后才可以使用。

aerich迁移工具的使用

  1. 初始化配置文件和迁移位置:
    aerich init -t main.TORTOISE_ORM_CONFIG
  2. 初始化后在main.py同级目录下会生成一个空的migrations文件夹,和pyproject.toml文件, pyproject.toml内容如下:
    [tool.aerich]
tortoise_orm = "main.TORTOISE_ORM_CONFIG"
location = "./migrations"
src_folder = "./."
  3. 初始化数据库。
    aerich init-db
  4. 初始化后会在migrations文件夹下生成一个models文件夹, 同时生成一份0_{datetime}_init.sql数据库迁移文件, 并且在数据库中添加一个名为aerich的迁移表。
    -- upgrade --
CREATE TABLE IF NOT EXISTS `aerich` (
    `id` INT NOT NULL PRIMARY KEY AUTO_INCREMENT,
    `version` VARCHAR(255) NOT NULL,
    `app` VARCHAR(100) NOT NULL,
    `content` JSON NOT NULL
) CHARACTER SET utf8mb4;
  5. 更新数据库迁移文件。如果models有更新，会在migrations/models文件夹中新生成一份1_{datetime}_update.sql的数据库迁移文件。
    aerich migrate
  6. 把迁移文件更新到数据库。
    aerich upgrade
  7. (可选) 降级数据库1: 查看历史版本。
    aerich history
  8. (可选) 降级数据库2: 降级到指定版本。
    aerich downgrade -v [版本]
  9. (可选) 降级数据库3: 查看被降级的版本。
    aerich heads
  10. (可选) 迁移文件整合、损坏修复

通过文档创建用户

  1. 启动项目：uvicorn main:app --reload。

  2. 访问文档地址：http://127.0.0.1:8000/docs。

  3. 依次点击
    在这里插入图片描述

  4. 修改请求值（因为email字段非必填，所以这里没有填写email参数），然后点击执行按钮。
    在这里插入图片描述

  5. 然后在下面可以看到响应数据，说明用户已经创建完成。
    用户创建完成
    用户创建的接口完成，下面开始写用户的登录接口

用户登录

  1. 打开文件views/login.py，新增一个登录接口。
    from fastapi import APIRouter, HTTPException, Depends, Body
from pydantic import BaseModel
from starlette import status
from models.user import User


router = APIRouter(
    # 请求路径
    prefix="/1/login",
    # 标签, 文档上显示
    tags=["登录"],
)

class RequestUserLogin(BaseModel):
    """
    用户登录请求数据校验
    """
    phone: str = Body(..., max_length=11, description="登录手机号")
    password: str = Body(..., description="登录密码")
    

class ResponseUserLogin(BaseModel):
    """
    用户登录响应数据
    """
    name: str = None
    access_token: str = None


@router.post("/", response_model=ResponseUserLogin, response_model_exclude_unset=True)
async def login(data: RequestUserLogin):
    """
    登录
    :param data:
    :return:
    """
    user = User.filter(phone=data.phone, password=data.password)
    if not user:
        raise HTTPException(status_code=status.HTTP_400_BAD_REQUEST, detail="用户名或密码错误.")
    # 生成一个token返回给前端, 做登录校验使用
    access_token = "0123456789"

    return {"access_token": access_token, "name": user.name}
  2. 写个脚本使用requests调用一下登录接口，测试接口的可用性（可选）。
    import requests

url = "http://127.0.0.1:8000/1/login/"

payload = {
   "name": "用户名",
   "password": "密码123"
}
headers = {
   'Authorization': '0123456789',
   'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())
    返回以下内容表示登录成功：
    {
    "name": "用户名",
    "access_token": "0123456789"
}
时光不写代码
关注
  • 1
    点赞
  • 踩
  • 38
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 1
    评论
专栏目录
Python FastAPI 框架 操作Mysql数据库 增删改查
weixin_46703850的博客
01-19 6897
Python FastAPI 框架 操作Mysql数据库 增删改查
【FastAPI微服务项目实战】环境的安装和配置
未来就在脚下。
12-11 668
Python-multipart 是一个 Apache2许可的 Python 流式多部分解析器。成功执行以上的安装指令后，我们就拥有了一个可用的FastAPI的微服务开发环境了。ms是Microservice的缩写，这里的环境名称可以按照喜好设定。Uvicorn 是用于 Python 的 ASGI Web 服务器。请按照序号递增的顺序进行操作。
【tortoisegit 常见配置错误】
weixin_45310430的博客
06-20 754
tortoiseGit 配置和常见错误
FastAPI完全指南：实现高效、安全的Web开发
最新发布
Innocence_0的博客
05-26 741
在快速发展的互联网时代，高效的Web开发变得尤为重要。Python作为一门广受欢迎的编程语言，其众多Web框架中，FastAPI凭借其出色的性能和易用性，成为了一个炙手可热的选择。FastAPI是一个用于构建API的现代、高性能的Web框架，它基于Python3.6+的类型提示，提供了快速、直观且易于学习的API开发体验。响应类型FastAPI允许你定义多种响应类型，包括JSON、HTML、纯文本等。return “文档定制FastAPI允许你自定义这些文档的一些方面，如标题、描述和版本号。
Python Web之FastAPI框架实战训练营：老程序员手把手带您
03-08
课程大纲：一、开始之前的准备1.Web应用程序概述2 Fast API框架介绍3.环境搭建二、第一个Fast API程序4.第一个Fast API程序5.HTTP请求方法请求资源关系6.路由三、路径参数、查询参数、请求体7.路径参数8.带类型的路径参数9.示例1：通过图书编号查找图书信息10.查询参数11.请求体12.请求体+路径参数13.请求体+路径参数+查询参数四、使用模板14.使用模板15.访问静态文件五、使用表单16.表单数据六、请求与响应17.Request请求对象18.Response响应对象19.响应模型七、用户数据与安全20.使用Cookie21.使用Session22.JWT身份验证23.CORS（跨域资源共享）八、基于SQLite的『用户管理』项目实战训练24.使用SQLite数据库25.示例2：用户管理：访问数据库层实现26.示例3：用户管理：前端与API实现九、基于SQLAlchemy ORM框架实现的『用户管理』项目实战训练27.使用SQLAlchemy框架25.示例2：用户管理：访问数据库层实现26.示例3：用户管理：前端与API实现27.使用SQLAlchemy框架28.示例4：SQLAlchemy实现用户管理数据访问层29.示例5：用户管理：前端与API实现知识图片：课程优势纲：课程内容紧跟企业一线开发讲解采用：理解+实践课件采用思维导图课件详细代码完整提供开源软件答疑服务
FastAPI学习（二）——FastAPI+Jinjia2模板渲染网页（跳转返回渲染页面）
weixin_43813200的博客
07-22 4824
官方文档位置： https://fastapi.tiangolo.com/advanced/templates/ （B站学习网址https://www.bilibili.com/video/av93282315）首先，必须注意的是，FastAPI这个Python Web框架并没有带渲染的网页模板引擎，但是也正因为如此，它可以使用任何网页模板。 官方例子是jinjia2 。 aiofiles是静态网页需要的包特别说明的是，Starlette 是一个轻量级 ASGI 框架/工具包，FastAPI一大特色。然后
FastAPI-示例：一个FastAPI的项目示例
02-13
简介一个FastAPI的项目示例项目使用说明安装依赖库项目依赖 ➜ pip3 install -r requirements.txt开始运行程序➜ python app.py开源说明此代码仅用于学习，可以许可，不能用于其他用途。
初始化搭建Fastapi项目一键生成脚本
01-30
初始化搭建Fastapi项目一键生成脚本
毕设&课程作业_项目是基于FastAPI框架搭建的脚手架模板。.zip
01-24
计算机类毕业设计、课程作业，系统源码！！！ 计算机类毕业设计、课程作业，系统源码！！！ 计算机类毕业设计、课程作业，系统源码！！！
fastapi-mvc-boilerplate:使用MVC模式实现的样本FastAPI项目
04-03
使用MVC模式实现的示例FastAPI项目。 :light_bulb: 特征 [ :check_mark: 麻省理工学院执照 [ :check_mark: ] FastApi + SQLAlchemy [ :check_mark: 带有fastapi-router-controller的基于类的控制器 [ :check_mark:...
FastApi实战源码
03-22
本项目主要介绍fastapi快速编写web服务，通过案例分别介绍项目搭建,接口编写,文档生成,模板渲染,excel读取,镜像部署等项目中常见的问题。data 目录是存放Excel数据文件 templates 目录是存放html模板文件 main.py ...
Python异步操作MySQL示例【使用aiomysql】
12-26
本文实例讲述了Python异步操作MySQL。分享给大家供大家参考，具体如下： 安装aiomysql 依赖 Python3.4+ asyncio PyMySQL 安装 pip install aiomysql 应用 基本的异步连接connection import asyncio from aiomysql import create_pool loop = asyncio.get_event_loop() async def go(): async with create_pool(host='127.0.0.1', port=3306, u
python编程规划_全面拥抱 FastApi — 多应用程序项目结构规划
weixin_39890629的博客
12-22 476
FastAPI最近比较火，自从看到这款框架后就一直在关注着。据官方文档上的介绍它是一个并发性可以和 NodeJS 以及 Go 相媲美的 web 框架，具有强大的性能本人最近也是一直在使用和学习 FastApi，相比之前用的框架性能确实有很大的提升，用完后有如下几点感受：性能并发更强了，支持异步 async基于 Pydantic 的类型声明，自动校验参数自动生成交互式的 API 接口文档上手简单，能...
【Python】FastApi框架搭建部署
Python、Golang、大数据
01-22 1250
FastApi 是一个现代、快速（高性能）的 web 框架，用于基于标准Python构建的API。
FastAPI 项目结构组织,工厂模式创建
王小右的博客
06-24 2942
FastAPI 项目结构组织,工厂模式创建 前言 学习Vue的时候，需要接口，而我恰巧也学习了下FastAPI，正好个人项目，试一下这个FastAPI框架。 然而 现在关于FastAPI，搜索资料基本都是官网翻译一下，要么就是官方推荐的 全栈项目生成https://github.com/tiangolo/full-stack-fastapi-postgresql, 对我目前的需求而言，太大了，而且全程用docker， 对我这个初学FastAPI的新手来说很不友好。于是我自己花了点时间, 详细看了一遍文档。
FastAPI的介绍，特性，及几个常用案例
热门推荐
数据知道的博客
12-30 4万+
一. 介绍 FastAPI 是一个用于构建 API 的现代、快速（高性能）的 web 框架，使用 Python 3.6+ 并基于标准的 Python 类型提示。 官方中文文档：https://fastapi.tiangolo.com/zh/ 官方文档： https://fastapi.tiangolo.com 源码： https://github.com/tiangolo/fastapi FastAPI依赖于下面这两大重要的成果： web部分参考：Starlette 数据部分参考：Pydantic fa
Centos7部署Fastapi
一枝芦苇
06-01 1276
【代码】Centos7部署Fastapi
Python开发规范(FastAPI项目)
axiaowua的博客
07-23 3230
一、概述 ​ 出于整个团队代码可读性、可维护性考量，有必要约定一套Python开发基本规范，从而提升项目可持续性开发，提升代码开发效率等。鉴于此，制订以下Python开发规范文档，本规范文档一经确认，Python开发人员需按照此文档规范进行项目Python后端的开发，对本文档不合理或不对之处请及时提出，在讨论统一意见后进行修改。 提高代码质量 统一项目代码风格 方便代码自审、他审依据参考 提升协作开发效率 促进个人成长 二、开发环境 如无特殊需要，选择 Python 3.7+ 版本解释器 开发环境尽
python api 框架_Python-FastAPI 异步框架开发博客系统（三）异步特性篇
weixin_39999859的博客
11-24 233
异步篇最接近Frodo的初衷了。通信与数据的内容使用传统框架的思路是相同的。而异步思路只改变了若干场景的实现方法。异步编程不是新鲜概念，但他并没有指定很明确的技术特点和路线。相关概念也不是很清晰，很少有文章能细致地说明白 阻塞/非阻塞、异步/同步、并行/并发、分布式、IO多路复用、协程 这些概念的区别与联系。这些概念在CS专业的OS、分布式系统课程中可能有设计，但具体实现层面可能鲜有涉及。具体到P...
fastapi项目实战
10-13
好的，关于 fastapi 项目实战，我可以给您提供一些思路和建议。首先，您需要确定您的项目类型和需求，然后选择合适的数据库和 ORM 工具。接着，您可以使用 fastapi 框架搭建后端服务，并编写 API 接口。最后，您可以使用 pytest 编写测试用例，确保项目的稳定性和可靠性。 如果您需要更具体的指导，可以参考以下资源： 1. FastAPI 官方文档：https://fastapi.tiangolo.com/ 2. FastAPI 实战教程：https://www.cnblogs.com/lsdb/p/13075856.html 3. FastAPI 实战项目源码：https://github.com/tiangolo/full-stack-fastapi-postgresql

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

时光不写代码

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值