【FastAPI】应用常见配置操作 & 路径配置操作

应用常见配置操作

主要对整个项目进行描述

app = FastAPI(
    title='FastAPI 标题',
    description='FastAPI 学习教程分享',
    version='1.0.0',
    docs_url='/docs',  # 默认 /docs 可以自定义
    redoc_url='/redoc',  # 默认 /redoc 可以自定义
)

路径配置操作

主要对接口进行描述

from fastapi import FastAPI
from pydantic import BaseModel
import uvicorn
from starlette import status

app = FastAPI()

class User(BaseModel):
    user_name: str
    password: str

@app.post(
    '/path_operation_configuration',
    response_model=User,
    tags=['用户信息'],
    summary='接口概括',
    # description='接口的功能描述', # 会覆盖 下面接口函数 注释的说明
    response_description='响应描述',
    # deprecated=True, # True 表示弃用接口，文档显示灰色 但还是可以用
    status_code=status.HTTP_200_OK
)
async def path(user: User):
    """
    - 接口的功能描述
    - 支持 MarkDown 语法
    :param user: 用户信息模型
    :return: 响应用户信息
    """
    return user.dict()

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