HibiAPI 开源项目教程

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

HibiAPI 项目的目录结构如下：

HibiAPI/
├── app/
│   ├── api/
│   ├── core/
│   ├── models/
│   ├── services/
│   ├── utils/
│   ├── __init__.py
│   ├── config.py
│   ├── main.py
│   └── requirements.txt
├── tests/
│   ├── __init__.py
│   └── test_main.py
├── .gitignore
├── LICENSE
├── README.md
└── setup.py

目录结构介绍

• app/: 包含应用程序的主要代码。
  • api/: 存放 API 接口的实现。
  • core/: 存放核心功能模块。
  • models/: 存放数据模型。
  • services/: 存放服务层代码。
  • utils/: 存放工具函数和类。
  • __init__.py: 初始化文件。
  • config.py: 配置文件。
  • main.py: 主启动文件。
  • requirements.txt: 依赖包列表。
• tests/: 包含测试代码。
  • __init__.py: 初始化文件。
  • test_main.py: 主测试文件。
• .gitignore: Git 忽略文件列表。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

项目的启动文件是 app/main.py。该文件负责启动整个应用程序。以下是 main.py 的主要内容：

from fastapi import FastAPI
from app.api import api_router
from app.config import settings

app = FastAPI(title=settings.PROJECT_NAME, version=settings.PROJECT_VERSION)

app.include_router(api_router)

if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host=settings.HOST, port=settings.PORT)

启动文件介绍

• FastAPI 实例化：创建一个 FastAPI 应用实例，并设置项目名称和版本。
• api_router 包含：将 API 路由包含到主应用中。
• uvicorn.run：使用 Uvicorn 运行应用程序，并设置主机和端口。

3. 项目的配置文件介绍

项目的配置文件是 app/config.py。该文件负责配置应用程序的各种设置。以下是 config.py 的主要内容：

from pydantic import BaseSettings

class Settings(BaseSettings):
    PROJECT_NAME: str = "HibiAPI"
    PROJECT_VERSION: str = "0.1.0"
    HOST: str = "0.0.0.0"
    PORT: int = 8000

settings = Settings()

配置文件介绍

• BaseSettings：使用 Pydantic 的 BaseSettings 类来管理配置。
• PROJECT_NAME：项目名称。
• PROJECT_VERSION：项目版本。
• HOST：主机地址。
• PORT：端口号。

通过这些配置，可以灵活地调整应用程序的运行参数。