skill整理-接口文档生成

curd一口气帮我生成好后,因为暂时还没接swagger都是用ai帮我生成接口文档的,调用如下

### 一键生成后台接口文档

当你开发完毕某个 Controller 或者希望了解某个已有 Controller 的接口详情时,**请将 Controller 代码名提供给 AI 助手,并附上以下指令:**

> **请使用 `Generate API Document For Controller` 这个 skill,为 `ShopProductController` 生成接口文档。**

**AI 助手收到指令后会自动执行以下规范:**
1. 自动读取并分析该 Controller 的入参(包括 Body 和 URL 参数)及出参(解析包含 `code`, `data`, `msg` 等包装对象的完整返回体)。
2. 根据方法语义,自动生成 Markdown 表格。
3. **强制**对每一个请求参数和返回参数(特别是 `data` 对象内部的嵌套字段)进行详细且具体的名词解析和含义说明。
4. 全程使用标准中文输出高质量的接口文档格式。

skill文档如下

---
name: Generate API Document For Controller
description: 根据Controller生成详细的接口文档,包含请求方式、入参解释、返回示例及返回字段详尽解释。
---

# Generate API Document For Controller

当你被要求为 Controller 或指定接口整理接口文档时,请严格按照以下结构和要求输出:

1. **接口基本信息**:
   - 接口名称
   - 接口路径 (Endpoint)
   - 请求方式 (GET/POST)
   - 请求体格式 (如 application/json, form-data, url parameters)

2. **入参说明 (请求参数)**:
   - 以表格形式列出所有请求参数。
   - 包含字段:参数名、数据类型、是否必填。
   - **必填要求**:每个字段必须有**详细的含义解释**(根据实体类或AO的注释/上下文推理)。
   - **核心要求**:如果是 POST/PUT 等包含 Request Body 的请求,必须单独提供一份具有代表性的 JSON **请求体示例**(Request Body Example)。

3. **返回数据说明 (响应参数)**:
   - 提供一个完整的、具有代表性的 JSON 返回格式样例 (必须包含系统基础外层结构,如 `code`, `msg`, `data`)。
   - **核心要求(强限制)**:以表格形式逐一解释返回的 JSON (尤其是 `data` 对象内部)中的每一个字段含义和数据类型。不可省略字段解释!

4. **输出格式**:
   - 必须使用标准的 Markdown 语法(多用表格和代码块)。
   - 全程使用中文(遵循全局指令要求)。
posted @ 2026-04-10 09:24  蜗牛使劲冲  阅读(2)  评论(0)    收藏  举报