FastAPI 元数据

2024-01-17

可以先通过 pydantic_settings 获取到 .env 中的环境变量，然后再传递给元数据使用。

class Settings(BaseSettings):
    app_name: str
    app_version: str


    class Config:
        env_file = ".env"




settings = Settings()


app = FastAPI(
    title=settings.app_name,
    version=settings.app_version,
    summary="接口概括说明",
)

禁用文档

在 main.py 中加入：

app = FastAPI(docs_url=None, redoc_url=None)
  • docs_url: 对应 /docs
  • redoc_url: 对应 /redoc

只关闭指定接口：

@app.post('/login', include_in_schema=False)

参考

# Python
# FastAPI