先创建AGENTS.md明确项目身份与约束,再用Codex按指令生成目录:根目录含main.py、.env.local;app/下分api/v1、core、db、models、schemas、services、cache、migrations;tests/和scripts/独立存在;三层隔离经codex check structure验证无误后方可导入代码。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要为FastAPI+PostgreSQL+Redis的电商API后端项目设计一套可长期维护、支持团队协作且能被Codex精准理解的目录结构,而不是直接套用模板导致后续AGENTS.md规则失效或文件归类混乱。
先建AGENTS.md再定目录
打开Codex桌面端→点击左下角「+ New Project」→选择你准备好的空文件夹(如ecommerce-api)→权限模式【必须选 auto-edit】。这一步不能跳过,否则Codex无法在执行前预览结构变更。
等右上角显示“0 files indexed”后,在根目录手动创建AGENTS.md文件,用自然语言写清项目身份:
明文 # 项目:电商 API 后端
## 背景
为独立站提供高并发商品/订单/用户接口,需支持灰度发布与数据库分片演进。
## 目标
生成符合FastAPI最佳实践的目录结构,所有业务模块可独立测试、单独部署。
## 约束条件
- 模型层必须与API路由解耦,禁止在routes/里直接import models
- 数据库迁移脚本统一放在migrations/,不混入alembic子目录
- Redis缓存逻辑封装在cache/,不散落在service中
- 所有环境变量从.env.local加载,禁止硬编码
【AGENTS.md必须在建目录前存在】,Codex会据此动态校验后续生成的每个子目录是否符合语义边界,比如它不会把cache/误判为utils/。
用指令驱动结构生成
在Codex对话框输入以下指令(注意换行与标点):
“按AGENTS.md约束条件,生成标准FastAPI后端目录结构:根目录含main.py和.env.local;创建app/包,内含__init__.py;在app/下建api/(放v1路由)、core/(含config.py和security.py)、db/(含base.py和session.py)、models/(Pydantic+SQLModel混合定义)、schemas/(纯Pydantic输出模型)、services/(含product_service.py和order_service.py)、cache/(redis_client.py和key_patterns.py)、migrations/(空目录);再建tests/和scripts/。”
通过本地 Codex 或 OpenClaw OAuth 凭证直接调用 ChatGPT/Codex Responses 的 image_generation 工具来生成或编辑光栅图像,然后保存
Codex进入规划模式后,会列出待创建的全部路径清单。确认无误后执行,约8秒生成完整结构。
这一步操作起来很简单,直接把指令粘贴进去就行,但要注意:如果指令里漏掉cache/或写成redis/,Codex会严格按字面执行,不会自动补全或纠错。
验证三层隔离是否生效
第一步:检查app/api/v1/endpoints/下是否有products.py和orders.py,确认它们只import app.schemas和app.services,不直接引用app.models。
第二步:打开app/services/product_service.py,查找是否包含from app.cache import redis_client,而非import redis。
第三步:运行codex check structure命令(Codex CLI内置),它会扫描整个目录并报告三处违规:① routes层是否调用了models层;② cache层是否被api层直连;③ migrations/是否为空目录。
若报告“0 issues”,说明结构已通过Codex原生校验规则。此时可安全导入已有代码——Codex会自动识别新文件所属层级并建议归位路径。














