技能库 / 开发工具 / REST API脚手架生成器

REST API脚手架生成器

根据数据模型自动生成完整的REST API项目结构,包含CRUD接口、参数校验、错误处理、数据库迁移和Swagger文档。

v1.0.0 开心鸟 已认证
作者 / 来源

local

REST API 后端开发 脚手架 代码生成 CRUD

安装方式

CLI 安装(推荐)

claw install custom-rest-api-scaffold-v1

需要安装 CLAW CLI

手动下载安装

下载 ZIP 后解压到技能目录即可安装。若在桌面客户端 WebView中直接下载出现异常,本站会改为提示页 + 原始链接,请按页内说明操作。

下载 ZIP (custom-rest-api-scaffold-v1-v1.0.0.zip)

触发指令

/scaffold-api
/gen-crud

跨平台安装指引

该技能声明兼容以下 4 个平台,将 ZIP 解压到对应目录即可被识别。

支持矩阵
Claude Code Coding Agent
macOS / Linux:~/.claude/skills/
Windows:%USERPROFILE%\.claude\skills\
unzip custom-rest-api-scaffold-v1-v1.0.0.zip -d ~/.claude/skills/
Cursor Coding Agent
macOS / Linux:~/.cursor/skills/
Windows:%USERPROFILE%\.cursor\skills\
unzip custom-rest-api-scaffold-v1-v1.0.0.zip -d ~/.cursor/skills/
Windsurf Coding Agent
macOS / Linux:~/.windsurf/skills/
Windows:%USERPROFILE%\.windsurf\skills\
unzip custom-rest-api-scaffold-v1-v1.0.0.zip -d ~/.windsurf/skills/
GitHub Copilot Coding Agent
macOS / Linux:~/.copilot/skills/
Windows:%USERPROFILE%\.copilot\skills\
unzip custom-rest-api-scaffold-v1-v1.0.0.zip -d ~/.copilot/skills/
目录不存在时请先 mkdir -p 创建;启用 Skill 后请重启对应 Agent 让配置生效。

使用指南

REST API 脚手架生成器

概述

根据用户提供的数据模型和业务需求,自动生成生产级别的REST API项目骨架。

Steps

  1. 需求收集:确认数据模型(字段名、类型、约束)、关联关系、业务规则
  2. 技术选型:根据用户偏好选择框架(Express/FastAPI/Gin)、ORM(Prisma/SQLAlchemy/GORM)、数据库
  3. 项目初始化:创建标准目录结构、初始化项目配置、配置环境变量
  4. 模型层生成:定义数据模型和数据库Schema、生成迁移文件、创建seed数据
  5. 接口层生成:为每个模型生成标准CRUD路由、添加请求参数校验、统一响应格式
  6. 中间件配置:全局错误处理、请求日志、CORS和Rate Limiting、认证中间件
  7. 文档生成:自动生成OpenAPI/Swagger文档

Pitfalls

  • 不要直接在Controller中写业务逻辑,保持Controller薄、Service厚
  • 分页查询必须包含总数和页码信息
  • 删除操作建议使用软删除
  • 关联查询注意N+1问题,使用预加载

Verification

  • 运行项目确保无启动错误
  • 使用curl/Postman测试每个CRUD接口
  • 验证参数校验是否正确拒绝非法输入