Codex 提示词最佳实践

实现一个用户登录 API 端点

# 上下文

- 项目使用 FastAPI 框架

- 已有 auth 模块处理认证逻辑

- 数据库使用 PostgreSQL

# 约束条件

- 使用现有的 JWT 工具生成 token

- 密码使用 bcrypt 验证

- 需要添加请求日志

# 期望结果

- 路径：POST /api/auth/login

- 请求体：{"email": "...", "password": "..."}

- 成功响应：{"token": "...", "user": {...}}

- 失败响应：{"error": "..."}

"实现完整的用户认证系统"

# 拆解成小任务

步骤 1："设计认证系统的数据结构，包括用户表和 token 表"

步骤 2："实现用户注册功能，包括密码加密和验证"

步骤 3："实现用户登录功能，生成 JWT token"

步骤 4："实现 token 验证中间件"

步骤 5："实现用户登出功能"

步骤 6："编写认证系统的测试"

步骤 7："更新 API 文档"

"项目使用 Django 4.2，数据库是 PostgreSQL 15"

# 引用现有代码

"参考 src/utils/validator.py 的验证逻辑"

# 指定文件

"修改 src/api/users.py，保持与其他 API 一致的风格"

# AGENTS.md 自动提供

创建 AGENTS.md 文件，Codex 会自动读取项目规范

"运行测试时出现错误：

AssertionError: Expected status 200 but got 500

at test_login.py:45

in test_successful_login

Full traceback:

...

分析原因并修复"

# 截图辅助

附加错误截图，Codex 可以直接查看

codex -i screenshot.png

codex --image design.png "根据设计稿实现页面"

# App/IDE

直接粘贴或拖拽图片到对话区域

# 多张图片

codex -i img1.png -i img2.png "对比这两张设计稿的差异"

"实现用户列表 API，支持分页"

# 检查后提出改进

"添加排序功能，支持按创建时间排序"

# 继续优化

"添加搜索功能，支持按用户名搜索"

# 性能优化

"优化查询性能，添加索引"

"修改那个函数"

# 明确的提示词（好）

"修改 src/utils/helper.py 中的 format_date 函数"

# 模糊的提示词（不好）

"让它更快"

# 明确的提示词（好）

"优化 query_users 函数，查询时间从 500ms 降低到 100ms 以内"

# 模糊的提示词（不好）

"加个功能"

# 明确的提示词（好）

"在用户 API 中添加批量删除功能，接收用户 ID 列表"

"参考 src/api/products.py 的风格，实现用户 API"

# 参考文档

"按照 OpenAPI 规范文档 docs/api-spec.yaml 实现"

# 参考示例

"按照这个格式返回响应：

{

'success': true,

'data': {...},

'message': '...'

}"

要求：

- 使用 [技术/库]

- 兼容 [现有系统]

- 包含 [边界处理]

- 返回 [响应格式]

参考：[现有类似功能路径]

触发条件：[什么情况下出现]

错误信息：

[完整错误堆栈]

期望行为：[正确结果应该是什么]

请分析原因并修复，不要影响其他功能。

# 示例

/review src/auth/for security issues

/review HEAD~5..HEAD for performance regressions