FastAPI系列 4 -路由管理APIRouter

FastAPI系列 -路由管理APIRouter

文章目录

一、前言

未来的py开发者请上座,在使用python做为后端开发一个应用程序或 Web API,很少会将所有的内容都放在一个文件中。FastAPI 提供了一个方便的工具,可以在保持所有灵活性的同时构建你的应用程序。

二、APIRouter使用示例

1、功能拆分

功能:在Web输入Url返回数据,但需要使用在users、books中定义的API

python 复制代码
├── fastapi
│   ├── __init__.py
│   ├── main.py
│   └── routers
│   │   ├── __init__.py
│   │   ├── users.py
│   │   └── books.py

app 目录包含了所有内容。并且它有一个空文件 app/init.py,它包含一个 app/main.py 文件。

routers 目录下有 books.pyusers.py 2个文件。

项目目录层级如下:

2、users、books模块开发

专门用于处理用户逻辑的文件是位于 /fastapi/routers/users.py 的子模块

users.py

python 复制代码
# -*- coding:utf-8 -*-
from fastapi import APIRouter
router = APIRouter()


# 获取用户列表
@router.get("/users/", tags=["users"])
async def read_users():
    return [{"username": "Teacher Li"}, {"username": "Teacher Tom"}]


# 获取个人详情
@router.get("/users/one", tags=["users"])
async def read_user_me():
    return {"username": "Teacher Li", "phone_number": "0123456789"}


# 获取用户名称
@router.get("/users/{username}", tags=["users"])
async def read_user(username: str):
    return {"username": username}

专门用于处理书逻辑的文件是位于 /fastapi/routers/books.py 的子模块

books.py

python 复制代码
# -*- coding:utf-8 -*-
from fastapi import APIRouter


router=APIRouter()

@router.get('/books', tags=["books"])
async def create_book(book):
    result={"book":book}
    return result

@router.get('/getbooks', tags=["books"])
async def get_book():
    result=[{"book":'测试1'},{'book':'测试2'}]
    return result

此模块中的所有路径操作都有相同的:

  • 路径 prefix:路径前缀 /users。
  • tags:(仅有一个 users 标签)。
  • responses: 定义响应状态码
  • dependencies:依赖项。

3、FastAPI主体

main.py

python 复制代码
import uvicorn
from fastapi import Depends, FastAPI
from routers import books, users


app = FastAPI()


app.include_router(users.router)
app.include_router(books.router)


@app.get("/")
async def root():
    return {"message": "Hello Bigger Applications!"}


if __name__ == '__main__':
    uvicorn.run(app,port=15341)

三、运行结果

uvicorn启动FastAPI后端

运行main.py

返回页面

启动服务,访问http://127.0.0.1:15341/docs,生成的APi交互文档

相关推荐
量子网络1 分钟前
debian 如何进入root
linux·服务器·debian
时光の尘4 分钟前
C语言菜鸟入门·关键字·float以及double的用法
运维·服务器·c语言·开发语言·stm32·单片机·c
paopaokaka_luck5 分钟前
[371]基于springboot的高校实习管理系统
java·spring boot·后端
以后不吃煲仔饭18 分钟前
Java基础夯实——2.7 线程上下文切换
java·开发语言
进阶的架构师19 分钟前
2024年Java面试题及答案整理(1000+面试题附答案解析)
java·开发语言
The_Ticker24 分钟前
CFD平台如何接入实时行情源
java·大数据·数据库·人工智能·算法·区块链·软件工程
大数据编程之光1 小时前
Flink Standalone集群模式安装部署全攻略
java·大数据·开发语言·面试·flink
我言秋日胜春朝★1 小时前
【Linux】进程地址空间
linux·运维·服务器
爪哇学长1 小时前
双指针算法详解:原理、应用场景及代码示例
java·数据结构·算法
ExiFengs1 小时前
实际项目Java1.8流处理, Optional常见用法
java·开发语言·spring