REST API 设计评审提示词

从命名、幂等、错误码、分页检查接口草案。

技术开发接口评审会OpenAPI 初稿

可复制正文

占位符:{{草案}}

请评审以下 API 设计草案: {{草案}} 检查维度:资源命名、HTTP 语义、鉴权、幂等、分页过滤、错误模型、版本策略、破坏性变更风险。 输出问题清单(严重/一般)与改写示例。

示例输入

草案 = POST /api/getUserList 用 body 传 page

示例输出(摘要)

指出动词路径与 GET 语义冲突,建议 GET /users?page=。

东莞市梦霓科技有限公司
粤ICP备2021102007号
REST API 设计评审提示词 | PromptVow