快速开始¶

本页将端到端介绍如何生成、运行和测试一个全新项目。

1. 生成项目¶

Bash

apogee new my-project
cd my-project

生成包含 31 个文件的脚手架。

2. 添加领域实体¶

Bash

apogee make:entity Customer \
  --field name:str \
  --field email:str \
  --field active:bool=true

生成实体、仓储（端口 + 实现）、用例、ORM、FastAPI 路由和迁移。

3. 运行项目¶

Bash

apogee up

在 8000 端口启动 app，在 5432 端口启动 postgres。访问 http://localhost:8000/docs 查看自动生成的 OpenAPI UI。

4. 测试 API¶

Bash

curl -X POST http://localhost:8000/customers \
  -H 'Content-Type: application/json' \
  -d '{"name": "Ada Lovelace", "email": "ada@example.com"}'

curl http://localhost:8000/customers

5. 停止与清理¶

Bash

apogee down              # 停止容器
apogee down --volumes    # 同时删除数据库卷

接下来¶

添加身份验证？→ apogee-auth 模块。
聊天机器人或 RAG？→ apogee-ai-rag 模块。
了解设计？→ 概念。