Skill Prompts提示词创建Skill

Cursor AI Skills 模板集合

本文档包含常用 Cursor Skill 模板，可直接复制使用或根据项目需求调整。

---

Skill 总览

#	Skill 名称	用途	使用频率
1	explain-interface	解释接口业务逻辑、数据库操作、表关系	⭐⭐⭐⭐⭐
2	generate-crud	生成标准增删改查代码	⭐⭐⭐⭐⭐
3	generate-sql	生成菜单 SQL、复杂查询	⭐⭐⭐⭐
4	bug-troubleshoot	常见问题排查与解决	⭐⭐⭐
5	code-review	代码质量审查与优化建议	⭐⭐⭐
6	generate-api-doc	生成标准 API 接口文档	⭐⭐⭐

1. 接口解释 Skill

使用场景

当你需要了解某个接口的实现逻辑、数据库操作、表关系时使用。

模板内容

---
name: explain-interface
description: 解释接口的业务逻辑，包括代码逻辑、数据库操作逻辑和涉及的表。
---

# 接口逻辑解释

## 模板结构

解释接口时，必须包含以下四个部分：

### 1. 接口概述
- 用途说明
- 请求方式、路径、参数
- 返回值说明

### 2. 代码逻辑
- Controller 层处理逻辑
- Service 层核心处理流程
- 数据转换过程

### 3. 数据库操作逻辑
- 按执行顺序列出所有数据库查询/操作
- 每次查询的条件和目的

### 4. 涉及的数据库表
- 表名
- 主要字段
- 表之间的关系

---

2. CRUD 代码生成 Skill

使用场景

需要快速生成一套增删改查代码时使用。

模板内容

---
name: generate-crud
description: 生成标准增删改查代码，包括 Controller、Service、Mapper、Entity、DTO。
---

# CRUD 代码生成规范

## 生成顺序

1. Entity 实体类
2. DTO 数据传输对象
3. Mapper 接口和 XML
4. Service 接口和实现
5. Controller 控制器

## Entity 规范
- 使用 MyBatis Plus 注解
- 字段添加注释
- 实现 Serializable

## DTO 规范
- 分页请求：XxxPageReqDTO
- 创建请求：XxxCreateReqDTO
- 更新请求：XxxUpdateReqDTO
- 响应对象：XxxRespDTO

## Controller 规范
- 使用 @PreAuthorize 权限注解
- 统一返回 CommonResult
- 分页接口：pageList
- 列表接口：list
- 详情接口：getDetail
- 新增接口：create
- 更新接口：update
- 删除接口：delete

## Service 规范
- 接口命名：IXxxService
- 实现类命名：XxxServiceImpl
- 使用 @Resource 注入 Mapper
- 优先使用 MyBatis Plus 方法

## 前端生成
- API 文件：src/api/模块/xxx.ts
- 页面文件：src/views/模块/xxx/index.vue
- 按钮权限：query/create/update/delete

---

3. SQL 生成 Skill

使用场景

需要生成菜单 SQL、复杂查询 SQL 时使用。

模板内容

---
name: generate-sql
description: 生成符合项目规范的 SQL，包括菜单 SQL、复杂查询SQL。
---

# SQL 生成规范

## 菜单 SQL 模板（禁止包含 id 字段）

-- 菜单（type = 2）
INSERT INTO `autumn`.`system_menu` 
(`name`, `permission`, `type`, `sort`, `parent_id`, `path`, `icon`, `icon_font`, `component`, `component_name`, `status`, `visible`, `keep_alive`, `always_show`, `creator`, `create_time`, `updater`, `update_time`, `deleted`) 
VALUES 
('菜单名称', '模块:页面:操作', 2, 排序值, 父菜单ID, '路由路径', 'ep:图标', '', '组件路径', '组件名', 0, b'1', b'1', b'1', 'admin', NOW(), 'admin', NOW(), b'0');

-- 按钮权限（type = 3），parent_id 填写上面插入后返回的ID
INSERT INTO `autumn`.`system_menu` 
(`name`, `permission`, `type`, `sort`, `parent_id`, `status`, `visible`, `keep_alive`, `always_show`, `creator`, `create_time`, `updater`, `update_time`, `deleted`) 
VALUES 
('查看', '模块:页面:query', 3, 1, 返回的ID, 0, b'1', b'0', b'0', 'admin', NOW(), 'admin', NOW(), b'0');

INSERT INTO `autumn`.`system_menu` 
(`name`, `permission`, `type`, `sort`, `parent_id`, `status`, `visible`, `keep_alive`, `always_show`, `creator`, `create_time`, `updater`, `update_time`, `deleted`) 
VALUES 
('新增', '模块:页面:create', 3, 2, 返回的ID, 0, b'1', b'0', b'0', 'admin', NOW(), 'admin', NOW(), b'0');

INSERT INTO `autumn`.`system_menu` 
(`name`, `permission`, `type`, `sort`, `parent_id`, `status`, `visible`, `keep_alive`, `always_show`, `creator`, `create_time`, `updater`, `update_time`, `deleted`) 
VALUES 
('修改', '模块:页面:update', 3, 3, 返回的ID, 0, b'1', b'0', b'0', 'admin', NOW(), 'admin', NOW(), b'0');

INSERT INTO `autumn`.`system_menu` 
(`name`, `permission`, `type`, `sort`, `parent_id`, `status`, `visible`, `keep_alive`, `always_show`, `creator`, `create_time`, `updater`, `update_time`, `deleted`) 
VALUES 
('删除', '模块:页面:delete', 3, 4, 返回的ID, 0, b'1', b'0', b'0', 'admin', NOW(), 'admin', NOW(), b'0');

## 注意事项
- 不允许使用子查询获取 parent_id
- 必须先执行菜单 SQL，获取返回的 id 后再执行按钮权限 SQL

---

4. Bug 排查 Skill

使用场景

遇到问题需要排查时使用。

模板内容

---
name: bug-troubleshoot
description: 帮助排查常见问题，提供排查步骤和解决方案。
---

# Bug 排查清单

## 通用排查步骤

1. 查看控制台错误信息
2. 查看 Network 请求响应
3. 查看后端日志
4. 检查数据库数据
5. 检查接口参数传递

## 前端问题

### 接口 400/404
- 检查接口路径是否正确
- 检查参数名是否匹配
- 检查请求方式是否正确

### 页面空白/白屏
- 检查控制台报错
- 检查路由配置
- 检查组件导入

### 数据不更新
- 检查响应式数据
- 检查接口返回
- 检查 v-model 绑定

## 后端问题

### 空指针异常
- 检查对象是否为 null
- 检查集合是否为空
- 检查 Optional 是否为空

### 数据库异常
- 检查 SQL 语法
- 检查字段映射
- 检查事务是否回滚

### 权限问题
- 检查 Token 是否过期
- 检查权限注解
- 检查用户角色

---

5. 代码审查 Skill

使用场景

代码提交前、代码 review 时使用。

模板内容

---
name: code-review
description: 审查代码，提出优化建议和潜在问题。
---

# 代码审查规范

## 审查重点

### 后端 Java
- 命名规范（驼峰命名）
- 空指针风险
- 事务是否正确
- 异常处理
- 日志记录
- SQL 注入风险

### 前端 Vue
- 组件命名规范
- 响应式数据使用
- 内存泄漏风险
- API 接口规范
- 类型安全

### 通用
- 代码重复
- 硬编码
- 安全漏洞
- 性能问题

---

6. API 文档生成 Skill

使用场景

需要为接口生成标准文档时使用。

模板内容

---
name: generate-api-doc
description: 为接口生成标准 API 文档。
---

# API 文档规范

## 文档格式

### 接口信息
- 接口名称
- 请求方式
- 请求路径
- 功能描述

### 请求参数
| 参数名 | 类型 | 必填 | 说明 |
|--------|------|------|------|

### 响应参数
| 参数名 | 类型 | 说明 |
|--------|------|------|

### 响应示例
```json
{
  "code": 0,
  "data": {},
  "msg": ""
}

错误码说明

code	说明
0	成功
500	服务器错误

---

创建方法

将上述内容保存为对应文件：

方式一：项目内 Skill

g:\PROJECT\.cursor\skills\xxx\SKILL.md

方式二：全局 Skill（推荐）

C:\Users\qy814\.cursor\skills-cursor\xxx\SKILL.md

方式三：放在 rules 中

g:\PROJECT\.cursor\rules\skills-template.md

---

快速使用

创建完成后，直接发送以下提示词即可：

接口解释

帮我解释 [接口路径] 这个接口

生成 CRUD

帮我生成 [模块名] 的增删改查代码

生成菜单 SQL

帮我生成 [菜单名称] 的菜单 SQL，父菜单ID是 [ID]

Bug 排查

我遇到了 [问题描述]，请帮我排查

代码审查

请帮我审查 [文件路径] 的代码

生成 API 文档

请为 [接口路径] 生成 API 文档