Codex怎么规划后端项目的目录结构

轻雪吖_5610

轻雪吖_5610

2026-10-13

786人浏览

原创

先创建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的创作门槛☜☜☜

codex怎么规划后端项目的目录结构

你需要为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 Imagen
Codex Imagen

通过本地 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会自动识别新文件所属层级并建议归位路径。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

codex codex后端开发

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2423

5

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

6270

13

后端的主要工作内容介绍
后端的主要工作内容介绍

后端是应用程序的服务端部分,负责核心任务,如数据库交互、业务逻辑处理和响应客户端请求。想了解更多后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

5646

10

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2423

5

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

6270

13

后端的主要工作内容介绍
后端的主要工作内容介绍

后端是应用程序的服务端部分,负责核心任务,如数据库交互、业务逻辑处理和响应客户端请求。想了解更多后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

5646

10

Codex AI 编程代理与智能开发工作流
Codex AI 编程代理与智能开发工作流

Codex 是一款超越传统代码生成的 AI 编程代理,致力于构建全生命周期的智能开发工作流。通过持久线程保留上下文,支持多智能体并行协作与后台自动化运维。借助沙箱权限控制、Plan/Steer 任务管理机制,Codex 既能自主拆解并执行复杂工程任务,又能让开发者牢牢掌控项目进程。从需求分析、编码测试到代码审查与部署,Codex 将 AI 深度融入研发全链路,极大提升了软件工程的交付效率与质量标准。

2026.05.26

514

10

Codex API集成与AI编程生态开发
Codex API集成与AI编程生态开发

Codex API 集成是构建下一代 AI 编程生态的核心基石,能通过 API 将强大的代码生成与推理能力无缝接入 VS Code、JetBrains 等主流 IDE 插件,还能将其深度嵌入 CI/CD 流水线,实现自动化的代码审查、单元测试生成与 Bug 修复。结合 Amazon Bedrock 等云平台的托管服务,企业可以灵活打造符合内部安全规范的专属 AI 编程助手。

2026.05.26

224

10

Codex 模型原理与AI软件工程进阶
Codex 模型原理与AI软件工程进阶

Codex 是基于通用大模型底座,通过海量代码语料与真实 Pull Request 进行专项微调的代码专用模型,能深度理解代码语法树与跨文件依赖,实现从自然语言到高质量工程代码的精准转化。在 AI 软件工程进阶中,Codex 推动了从提示词工程向“驾驭工程(Harness Engineering)”的范式跃迁。

2026.05.26

177

10

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Codex 应用程序简介
Codex 应用程序简介

共0课时 | 167人学习

Codex官方文档
Codex官方文档

共0课时 | 0人学习