结构化后端接口运维脚本编写提示词

角色定义与任务定位

请以资深后端开发工程师或系统运维专家的身份，运用本提示词方案。你的核心目标是：针对“结构化后端接口运维脚本”这一具体需求，生成可直接用于生产环境或作为开发蓝本的、逻辑严谨、健壮性高的脚本代码。你的产出不是概念说明，而是具备实战价值的工具。

适用场景

• 自动化接口健康检查与监控告警脚本。
• 批量接口回归测试与性能基准测试脚本。
• 日志分析、错误追踪与异常请求统计脚本。
• 接口数据备份、迁移或一致性校验脚本。
• 配合CI/CD流程的接口部署后验证脚本。

核心提示词

以下提示词组合可根据具体场景选择与调整，可直接复制使用：

• “编写一个Python脚本，使用requests库定时轮询[接口地址列表]，检查HTTP状态码、响应时间是否超过[阈值]毫秒，以及返回JSON中关键字段[例如：status]是否为预期值。将失败结果记录到[日志文件路径]并发送邮件告警到[邮箱地址]。”
• “生成一个Shell脚本，通过curl命令批量测试RESTful接口的GET/POST方法，对比响应体与预期结果文件（expected_*.json）的差异，并输出详细的对比报告。”
• “设计一个用于分析Nginx访问日志的脚本，统计指定时间段内各个接口端点（endpoint）的请求量、平均响应时间、错误码（4xx,5xx）分布，并生成可视化HTML报告。”
• “创建一个自动化脚本，从Swagger/OpenAPI文档中解析所有接口定义，自动生成对应的基础测试用例脚本框架（包含URL、方法、必要参数）。”

风格方向

• 代码风格：遵循PEP 8（Python）或Shell脚本最佳实践，注重可读性，包含清晰的函数定义和注释。
• 脚本结构：模块化设计，将配置（如URL、阈值）、核心逻辑、日志记录、错误处理分离。
• 输出风格：日志信息结构化（如JSON格式），控制台输出简洁明了，关键信息高亮或分级（INFO, WARNING, ERROR）。

构图建议

此处的“构图”指脚本的逻辑结构与数据流设计：

• 采用“初始化配置 -> 主循环/批量处理 -> 结果收集与判断 -> 输出与通知”的线性流程。
• 错误处理流程应作为并行分支，确保异常能被捕获、记录，且不会导致主流程意外中断。
• 考虑将工具函数（如HTTP请求封装、日志解析器）抽象为独立模块或函数，使主脚本逻辑清晰。

细节强化

• 健壮性：添加超时控制、重试机制（带退避策略）、网络异常处理。
• 安全性：敏感信息（如密码、密钥）通过环境变量或配置文件读取，避免硬编码。
• 可维护性：使用清晰的变量命名，在脚本开头提供必要的配置说明和示例。
• 扩展性：预留配置接口，方便未来增加新的检查项或通知渠道（如集成企业微信、钉钉机器人）。
• 环境兼容：注明脚本依赖的运行时环境、Python/Shell版本及第三方库。

使用建议

• 将“[ ]”中的占位符替换为您的实际参数，如具体接口URL、阈值、文件路径。
• 在实际部署前，请在测试环境充分运行，验证脚本逻辑与告警触发条件。
• 可将核心提示词与您的具体API文档、日志格式样本结合，生成更贴切的脚本。
• 建议将生成的脚本纳入版本控制系统（如Git），并编写简明的README说明其用途和运行方式。