[{"data":1,"prerenderedAt":84},["ShallowReactive",2],{"header-counts":3,"footer-counts":6,"prompt-api-design":9},{"tools":4,"reviews":5},65,7,{"tools":4,"reviews":5,"playbooks":7,"news":8},10,8,{"id":10,"title":11,"body":12,"description":67,"extension":68,"meta":69,"navigation":70,"path":71,"seo":72,"stem":73,"tags":74,"targetTools":78,"__hash__":83},"prompts\u002Fprompts\u002Fapi-design.md","API 设计 Prompt：从需求到 RESTful API 规范",{"type":13,"value":14,"toc":60},"minimark",[15,19,23,27,38,41],[16,17,18],"h2",{"id":18},"用法",[20,21,22],"p",{},"描述你的功能需求，AI 生成完整的 API 设计文档。",[16,24,26],{"id":25},"prompt","Prompt",[28,29,35],"pre",{"className":30,"code":32,"language":33,"meta":34},[31],"language-text","你是一个资深后端架构师。请根据以下需求，设计 RESTful API。\n\n## 需求描述\n\n{{描述你要实现什么功能，比如\"用户注册登录、文章 CRUD、评论系统\"}}\n\n## 已有约束\n\n- 框架：{{Express \u002F FastAPI \u002F Go Gin \u002F Spring Boot}}\n- 认证方式：{{JWT \u002F Session \u002F API Key}}\n- 数据库：{{PostgreSQL \u002F MySQL \u002F MongoDB}}\n\n## 要求\n\n1. 遵循 RESTful 规范（资源名复数、HTTP 方法语义正确）\n2. 统一的响应格式（成功\u002F失败）\n3. 合理的状态码（不要全用 200）\n4. 分页、排序、筛选的 query 参数规范\n5. 错误响应包含 error code + message + details\n6. 标注哪些接口需要认证\n\n## 输出格式\n\n### API 概览\n| 方法 | 路径 | 描述 | 认证 |\n|---|---|---|---|\n\n### 详细设计\n\n对每个接口：\n- 路径参数 \u002F Query 参数 \u002F Body 字段（含类型和校验规则）\n- 请求示例\n- 响应示例（成功 + 错误）\n- 状态码列表\n\n### 统一规范\n- 响应格式\n- 错误码定义\n- 分页格式\n","text","",[36,37,32],"code",{"__ignoreMap":34},[16,39,40],{"id":40},"设计原则提醒",[42,43,44,48,51,54,57],"ul",{},[45,46,47],"li",{},"GET 不改数据，POST 创建，PUT 全量更新，PATCH 部分更新，DELETE 删除",[45,49,50],{},"资源名用复数（\u002Fusers 不是 \u002Fuser）",[45,52,53],{},"嵌套关系最多 2 层（\u002Fusers\u002F:id\u002Fposts 合理，\u002Fusers\u002F:id\u002Fposts\u002F:id\u002Fcomments\u002F:id 太深）",[45,55,56],{},"分页用 offset+limit 或 cursor（大数据量用 cursor）",[45,58,59],{},"时间字段用 ISO 8601（不要用时间戳）",{"title":34,"searchDepth":61,"depth":61,"links":62},3,[63,65,66],{"id":18,"depth":64,"text":18},2,{"id":25,"depth":64,"text":26},{"id":40,"depth":64,"text":40},"描述你要做什么功能，AI 帮你设计 RESTful API：路由、请求\u002F响应格式、状态码、错误处理、分页规范，直接输出 OpenAPI 风格文档。","md",{},true,"\u002Fprompts\u002Fapi-design",{"title":11,"description":67},"prompts\u002Fapi-design",[75,76,77],"API","REST","后端设计",[79,80,81,82],"Claude","Cursor","ChatGPT","GLM","B0HGcZ68vbsPRtN14180LcLX7GgQYlT_CAQeZ0TsB2w",1782316489337]