RESTful 接口规范审查
输入待设计或评审的 API 定义,依据 REST 规范核验 URL 命名、响应结构、鉴权与状态码并输出调整建议。
功能与用途
本技能为后端开发与接口设计提供标准化的 RESTful 规范约束。当你需要新增接口、重构端点或进行代码审查时,只需提供接口路径或响应结构,AI 会自动按统一标准检查 URL 命名、JSON 响应封装(data/error/meta)、HTTP 状态码及 Bearer 鉴权配置,输出符合工程规范的接口定义与修正建议。
适用场景
- 新建接口设计:设计新功能的数据接口时,自动生成符合层级嵌套与动词规约的 RESTful URL 与响应体。
- 接口代码审查:在 Pull Request 评审中核对端点命名、状态码映射及 Bearer 鉴权是否符合团队规范。
- 统一响应格式:为分页列表或异常抛出统一封装 data、error、meta 字段,保持前后端数据交互一致。
适用人群
- 后端开发工程师
- API 架构师
- 全栈开发者
- 技术团队 Code Review 人员
使用步骤
- 提供准备设计或审查的 API 路由与业务场景描述
- AI 依据规范核对命名、嵌套层级、参数传递方式
- 检查响应结构是否包含标准 data、error 与 meta 字段
- 获取格式化后的接口文档或修改对比建议并应用到项目中
开始使用
将需求和 Skill 名称发送给已连接 SkillPX MCP 的 AI 助手,核对适用工具和安装要求。
技术信息
- 分类
- 编程
- 适用工具
- Codex、Claude Code、OpenClaw、Hermes Agent、国内 Agent
- 使用难度
- 简单
- 版本
- main
- 最近更新
- 2026-09-30
- 文件数
- 3
- 安装包大小
- 自动生成 ZIP
- 安全检查
- 基础检查通过
API design patterns and conventions for this project. Covers RESTful URL naming, response format standards, error handling, and authentication requirements. Use when writing or reviewing API endpoints, designing new APIs, or making decisions about request/response formats.