FastAPI Cache 项目教程

FastAPI Cache 项目教程

fastapi_cacheFastAPI simple cache项目地址:https://gitcode.com/gh_mirrors/fa/fastapi_cache

1. 项目的目录结构及介绍

FastAPI Cache 项目的目录结构如下：

fastapi_cache/
├── README.md
├── fastapi_cache/
│   ├── __init__.py
│   ├── cache.py
│   ├── config.py
│   └── main.py
├── requirements.txt
└── tests/
    ├── __init__.py
    └── test_cache.py

目录结构介绍

• README.md: 项目说明文档。
• fastapi_cache/: 项目的主要代码目录。
  • __init__.py: 模块初始化文件。
  • cache.py: 缓存功能实现文件。
  • config.py: 配置文件。
  • main.py: 项目启动文件。
• requirements.txt: 项目依赖文件。
• tests/: 测试代码目录。
  • __init__.py: 测试模块初始化文件。
  • test_cache.py: 缓存功能测试文件。

2. 项目的启动文件介绍

项目的启动文件是 fastapi_cache/main.py。该文件主要包含以下内容：

from fastapi import FastAPI
from fastapi_cache import cache
from fastapi_cache.config import settings

app = FastAPI()

@app.on_event("startup")
async def startup():
    await cache.init()

@app.get("/")
@cache.cached()
async def read_root():
    return {"message": "Hello World"}

if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="0.0.0.0", port=8000)

启动文件介绍

• from fastapi import FastAPI: 导入 FastAPI 类。
• from fastapi_cache import cache: 导入缓存模块。
• from fastapi_cache.config import settings: 导入配置模块。
• app = FastAPI(): 创建 FastAPI 应用实例。
• @app.on_event("startup"): 定义应用启动时的事件处理函数。
• @app.get("/"): 定义一个 GET 请求的路由处理函数，并使用缓存装饰器 @cache.cached()。
• if __name__ == "__main__":: 使用 uvicorn 运行应用。

3. 项目的配置文件介绍

项目的配置文件是 fastapi_cache/config.py。该文件主要包含以下内容：

from pydantic import BaseSettings

class Settings(BaseSettings):
    CACHE_HOST: str = "localhost"
    CACHE_PORT: int = 6379
    CACHE_DB: int = 0

settings = Settings()

配置文件介绍

• from pydantic import BaseSettings: 导入 Pydantic 的 BaseSettings 类。
• class Settings(BaseSettings): 定义配置类，继承自 BaseSettings。
• CACHE_HOST: str = "localhost": 定义缓存服务器的主机地址。
• CACHE_PORT: int = 6379: 定义缓存服务器的端口号。
• CACHE_DB: int = 0: 定义缓存数据库的编号。
• settings = Settings(): 创建配置实例。

以上是 FastAPI Cache 项目的教程，包含了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助！

fastapi_cacheFastAPI simple cache项目地址:https://gitcode.com/gh_mirrors/fa/fastapi_cache