Fastapi之常见配置

1.路径操做配置

@app.post(
  "/path_operation_configuration",
  response_model=xxx,
  # 接口描述，一般放在`app.include_router`里面，做一个模块划分
  # 如果有有多个，则在文档中国该接口会分别展示多条
  tags=['path', 'Operation', 'Configuration'],
  summary="This is summary",  # 接口文档中接口路径后面的描述，默认是该接口对应的方法名，首字母大写
  description="This is description",  # 接口文档中的描述
  response_description="This is response description",  # 响应体的描述
  deprecated=True,  # 表示接口已经废弃，在文档中会展示灰色，且被中划线划掉，但是还可以正常调用，只做展示而已
  status_code=status.HTTP_200_OK
), 

1.Fastapi常见的配置

app = FastAPI(
    title="FastAPI Tutorial",   # 文档标题
    description="FastAPI接口文档，项目代码：https://github.com/xxxx",  # 文档描述
    version='1.0.0',  # 版本描述
    docs_url='/docs',  # 文档路径
    redoc_url='readme_docs'  # redoc文档路径
)