进阶版后端接口Python脚本编写提示词

角色定义与任务定位

本提示词方案适用于以下角色与目标：

• 角色：资深后端架构师 / Python 高级开发工程师
• 目标：利用 AI 代码生成工具，一次性产出结构清晰、符合生产标准、包含完整错误处理与日志记录的后端接口 Python 脚本
• 输出预期：可直接集成到项目中的函数或类，支持主流 Web 框架（FastAPI / Flask / Django），并附带类型注解、单元测试示例与注释说明

适用场景

• 快速搭建 RESTful API 端点（增删改查）
• 实现与数据库（PostgreSQL / MySQL / MongoDB）的安全交互
• 编写包含认证鉴权（JWT / OAuth2）的后端服务
• 生成具备异步处理能力的 I/O 密集型接口
• 为已有项目补充规范化文档与错误处理逻辑

核心提示词

以下内容可直接复制到 AI 工具中，作为生成指令的核心部分（请根据实际需求替换括号内参数）：

• “以资深后端开发工程师身份，使用 Python 和 [FastAPI/Flask/Django] 框架，编写一个 [HTTP 方法] 接口，路径为 /api/v1/[资源名称]，用于 [具体功能描述]。”
  示例：“编写一个 POST 接口 /api/v1/users，用于注册新用户，需包含邮箱、密码和用户名的输入验证。”
• “数据模型使用 Pydantic（若 FastAPI）或 Django Model / Flask-SQLAlchemy，定义字段类型、默认值及自定义验证器。”
  示例：“字段 email 必须符合 email 格式，password 长度至少 8 位并返回哈希结果。”
• “接口需包含完善的异常处理：使用 try-except 捕获常见异常（如数据不存在、重复键、连接超时），并返回统一 JSON 错误结构：{‘error’: ‘错误类型’, ‘message’: ‘详细信息’}。”
• “为每个接口添加日志记录：使用 logging 模块，记录请求方法、路径、状态码及执行时间（ms）。”
• “代码风格遵循 PEP 8，包含类型注解（函数参数与返回类型），并为每个函数编写 docstring（遵循 Google 风格或 reStructuredText）。”
• “如需异步：使用 async def 与 await，数据库操作采用异步 ORM（如 SQLAlchemy Async 或 Databases）。”
• “最后提供一段简单的单元测试（基于 pytest），覆盖正常请求、参数缺失与鉴权失败三种场景。”

风格方向

• 生产级：代码健壮，禁止硬编码，使用环境变量管理配置（.env / pydantic-settings）
• 可读性强：合理组织目录结构（如: app/ ├── routers/ ├── models/ ├── schemas/ ├── services/ ├── core/ └── tests/）
• 安全优先：输入消毒、SQL 注入防护（参数化查询）、密码 bcrypt 哈希、CSRF 保护
• 文档自动化：自动生成 OpenAPI 文档（FastAPI 自带）或使用 apidoc / drf-spectacular

构图建议

• 代码逻辑流程建议：请求进入 → 中间件（认证/限流）→ 路由处理 → 参数校验 → 业务逻辑 → 数据库操作 → 异常捕获 → 响应序列化 → 返回
• 接口架构图建议（用于文档）：绘制分层依赖关系，体现 Router → Service → Repository → Database 的职责划分
• 注释与空白行：每段逻辑块（约 10-15 行）之间留空行，关键判断处添加行内注释

细节强化

• 错误信息国际化：预定义错误码枚举（如 ErrorCode.USER_NOT_FOUND），避免直接暴露系统错误
• 分页与排序：若接口需返回列表，默认支持 page、page_size、sort_by 参数，并返回 total 与 total_pages
• 请求限流：集成 slowapi 或自定义中间件，限制每 IP 每分钟调用次数
• 健康检查端点：添加 /health 返回服务状态与数据库连接状态
• 版本管理：URL 前缀体现 API 版本（v1/v2），便于向后兼容
• 性能优化：为数据库查询添加 select_related / prefetch_related（ORM），或使用缓存（Redis）

使用建议

• 调整粒度：根据项目复杂度修改“核心提示词”中的框架与细节要求，简单接口可省略异步与缓存
• 多轮迭代：首先生成基础骨架，再逐步要求添加认证、日志等模块，避免单次输出过长导致上下文丢失
• 结合上下文：将现有项目的目录树或 models 文件粘贴到提示词之前，让 AI 理解现有代码风格
• 测试驱动：先写测试提示词，再要求生成满足测试的代码，提高输出可靠性
• 版本控制：生成后立即执行 git init 并提交初始版本，方便对比后续优化