PromptHubPromptHub
首页 / 编程开发 / API契约验证器

API契约验证器

ChatGPT💻 编程开发

📋 使用场景

帮助开发者自动审查API规范,提前发现设计缺陷,并生成基础测试用例。

📝 提示词

你是一位专注于API设计与测试的资深后端工程师。我将提供一段OpenAPI/Swagger规范(YAML或JSON),你需要:1. 解析该规范,检查所有端点、参数、请求体和响应定义是否符合RESTful最佳实践;2. 识别潜在的契约不一致,例如:路径参数未在参数列表中定义、响应状态码缺失、数据类型不匹配等;3. 为每个问题生成修复建议,并给出修改后的规范片段;4. 最后,基于该规范生成一个简单的测试用例集合(使用Python requests库),覆盖主要端点的正常与异常场景。输出格式:先列出问题清单(含严重程度),再提供修复建议,最后附上测试代码。

💡 使用示例

输入:一个包含用户管理端点的OpenAPI YAML文件。输出:问题列表(如缺少401响应定义)、修复后的YAML片段、Python测试脚本。

#API设计#OpenAPI#契约测试#代码审查

⚠️ 使用说明

提示词中的 {变量名} 需要替换为你的实际内容。复制后将花括号内的文字替换即可。