后端接口Python脚本编写实战版提示词

角色定义与任务定位

你应以一名经验丰富的后端开发工程师或技术架构师的身份，运用此提示词方案。你的核心目标是：快速、准确地生成符合RESTful设计规范、具备良好可读性与健壮性的Python后端接口脚本。本方案旨在将开发需求转化为可直接驱动代码生成工具（如AI编程助手）或指导手动编码的结构化指令。

适用场景

• 快速原型开发，需要为Web应用或微服务生成API端点。
• 教学演示或技术文档编写，需要清晰、规范的接口代码示例。
• 自动化脚本编写，用于处理HTTP请求、数据库交互或第三方服务集成。
• 代码重构或标准化，为现有项目建立统一的接口编写模板。

核心提示词

以下提示词组合可直接复制使用，填入具体业务参数即可生成目标代码。

• 基础GET接口：使用Python FastAPI框架，编写一个GET类型的用户信息查询接口“/api/user/{user_id}”。需要包含路径参数验证、数据库异步查询（使用SQLAlchemy ORM）、标准的成功响应与404异常处理。返回JSON格式的用户名、邮箱和创建时间字段。
• 数据提交POST接口：创建一个用户注册接口“/api/auth/register”，方法为POST。请求体需验证用户名（字符串，最小长度3）、密码（加密存储）和邮箱（符合邮箱格式）。实现数据验证（使用Pydantic模型）、密码哈希处理（bcrypt）、用户记录异步插入数据库，并返回201状态码及新用户ID。
• 综合管理接口：设计一个文章管理接口“/api/articles”，支持GET（分页查询文章列表，包含过滤条件）、POST（创建新文章，需验证标题和内容）。要求使用依赖注入处理数据库会话，对查询结果进行序列化，并统一使用自定义响应模型封装返回数据。

风格方向

• 代码风格：遵循PEP 8规范，注重代码整洁与命名清晰。优先采用异步编程（async/await）提升性能。
• 架构风格：采用分层结构（路由层、业务逻辑层、数据访问层分离），体现关注点分离原则。强调类型提示（Type Hints）的全面使用。
• 文档风格：代码内应包含清晰的文档字符串（Docstring），自动生成API交互文档（如OpenAPI）。

构图建议

• 代码结构“构图”：按照“导入依赖 → 定义Pydantic模型/请求响应体 → 编写路由函数 → 实现核心业务逻辑 → 错误处理”的顺序组织代码块，逻辑流清晰。
• 重点突出：在提示词中明确要求将“输入验证”、“数据库事务”、“错误处理”作为代码块的核心部分进行详细生成。
• 模块化视角：提示词应引导生成功能内聚的独立函数或方法，便于后续复用和测试。

细节强化

• 安全性：明确要求加入输入消毒、SQL注入防护、密码哈希、JWT令牌验证（如适用）等安全实践。
• 健壮性：强调异常处理的完备性，包括数据库连接异常、数据不存在、重复键冲突、业务逻辑异常等场景，并返回有意义的HTTP状态码和错误信息。
• 可观测性：建议集成日志记录，对接口的请求、关键操作和错误进行分级记录。
• 性能：提示考虑数据库查询优化（如索引、懒加载）、响应缓存（Redis）、异步任务处理等细节。

使用建议

• 将上述“核心提示词”直接输入至AI编程助手，可快速获得可运行的代码草稿，随后根据具体项目需求进行微调。
• 在实际项目中，请将提示词中的框架（如FastAPI）、数据库ORM（如SQLAlchemy）替换为项目实际使用的技术栈。
• 根据接口复杂度，可组合使用不同提示词。例如，先生成基础CRUD接口，再使用“细节强化”中的要求进行迭代优化，添加安全与日志功能。
• 此方案亦可用于团队编码规范制定，将各模块要求作为代码审查的检查点。