高阶版后端接口Python脚本编写提示词
本提示词方案专为需要生成高质量Python后端接口脚本的开发场景设计,提供从角色定位到具体实现的...
提示词内容
复制角色定义与任务定位
请以“资深后端架构师与Python开发专家”的身份,进行本次内容生成。你的核心目标是:为生成一个符合生产环境要求、结构清晰、功能完整且具备良好可维护性的Python后端接口脚本,提供一套可直接执行的、模块化的提示词方案。你的产出不是理论讲解,而是能直接驱动代码生成或指导开发实践的“施工蓝图”。
适用场景
- 快速原型开发:需要基于明确的功能需求,快速生成可运行的接口脚本雏形。
- 代码规范化生成:在团队协作中,需要生成符合特定编码规范(如PEP 8)和项目结构的接口代码。
- 功能模块实现:针对特定业务逻辑(如用户认证、数据查询、文件处理等)生成标准化的接口处理函数。
- 教学与示例:创建结构良好、注释清晰的示例代码,用于演示后端接口的最佳实践。
核心提示词
以下提示词组合可根据具体场景选择或组合使用,直接输入以生成对应代码:
- 生成一个基于Flask框架的RESTful API端点,实现用户信息的GET(查询列表)和POST(新增)操作,使用SQLAlchemy ORM连接MySQL数据库,包含请求数据验证(使用Pydantic或Flask-WTF)和基本的错误处理。
- 编写一个FastAPI异步接口,用于处理文件上传,支持图片格式验证、大小限制,并将文件元信息存储到PostgreSQL,返回文件的访问URL。包含依赖注入进行用户认证。
- 创建一个Django REST framework的视图集(ViewSet),包含对“产品”模型的完整CRUD操作,支持分页、过滤(按价格范围、类别)和权限控制(仅管理员可修改)。
- 实现一个Python脚本,使用requests库作为客户端调用第三方天气API,解析返回的JSON数据,并将结果格式化后写入本地SQLite数据库,包含超时重试机制和API密钥管理。
风格方向
- 代码结构:严格遵循单一职责原则,按功能分离路由、业务逻辑、数据模型和工具函数。采用工厂模式或依赖注入管理应用实例。
- 注释与文档:为每个函数和复杂逻辑块添加清晰的docstring(遵循Google或reStructuredText风格)。关键步骤需有行内注释。
- 命名规范:变量和函数名使用snake_case,类名使用CamelCase,常量使用UPPER_SNAKE_CASE,确保名称具有描述性。
- 错误处理:使用明确的异常类型(如ValueError, HTTPException),提供有意义的错误信息和适当的HTTP状态码,避免裸露的except。
构图建议(代码组织框架)
- 导入区块:标准库、第三方库、本地模块分块导入,顺序清晰。
- 配置与初始化:集中管理数据库连接、应用配置、密钥等。
- 数据模型定义:使用ORM类或Pydantic模型明确定义数据结构。
- 路由与视图函数:路由装饰器或声明集中,视图函数逻辑层次分明(参数解析 -> 验证 -> 业务处理 -> 响应封装)。
- 工具函数与中间件:将认证、日志、数据库会话管理等跨切面关注点模块化。
- 主程序入口:明确应用启动方式(如
if __name__ == '__main__':)。
细节强化
- 输入验证:对请求参数、请求体进行严格类型、范围、格式验证,并返回具体的验证错误信息。
- 日志记录:集成logging模块,记录接口访问、错误、关键业务操作,便于调试和审计。
- 数据库操作:使用会话管理确保连接正确关闭,考虑事务处理,对复杂查询进行性能优化。
- 响应标准化:统一响应格式,如
{“code”: 200, “msg”: “success”, “data”: {}},便于前端处理。 - 安全性:对敏感信息进行脱敏,防范SQL注入、XSS等常见Web攻击,使用HTTPS。
- 异步支持:在I/O密集型操作(如网络请求、文件读写)中考虑使用async/await提升性能。
使用建议
- 将上述“核心提示词”直接复制到你的AI编程助手(如ChatGPT、Cursor、Claude)或代码生成工具中,作为主要输入指令。
- 在生成代码后,根据“风格方向”和“细节强化”要点进行代码审查和优化,替换占位符(如数据库连接字符串、API密钥)。
- 根据实际项目框架(Flask/FastAPI/Django)和数据库选型,调整核心提示词中的具体技术栈关键词。
- 对于复杂业务,可先使用提示词生成基础框架,再分模块(如“仅生成用户认证的中间件函数”)细化填充。
- 始终在安全环境中测试生成的代码,特别是涉及数据库操作和外部API调用的部分。