当前位置: 首页 > news >正文

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 语法(多用表格和代码块)。- 全程使用中文(遵循全局指令要求)。
http://www.jsqmd.com/news/617435/

相关文章:

  • xmame(0.106)在imx6q上移植
  • 终极键盘防抖软件指南:彻底解决机械键盘重复输入问题
  • BepInEx实战指南:5步构建Unity游戏模组开发环境
  • 3分钟学会Windows和Office激活:KMS_VL_ALL_AIO一键解决方案
  • 让老旧Mac重获新生:OpenCore Legacy Patcher完整使用指南
  • 八大网盘直链下载助手:免费高速下载的完整终极解决方案
  • 碧蓝航线Alas脚本:让游戏自动化的终极懒人指南 [特殊字符]
  • SpringBoot+MyBatis-Plus 实现用户管理模块 CRUD + 分页 + 条件查询(电商系统实战,代码可直接复制)
  • 百度网盘直链解析工具:让下载速度飞起来的秘密武器
  • Android Camera开发避坑指南:HAL3与MediaCodec整合的那些坑
  • 车辆电耗变化情况
  • 美团打造“视觉语言大一统“:让AI像人类一样看图说话生图聊天
  • Beyond Compare 5密钥生成终极指南:快速解决授权问题的完整教程
  • Xenos技术内幕:Windows DLL注入架构深度解析
  • 芯片设计经理开始研究AI了,“一人团队“真的要来了吗?
  • aibiye的AI工具针对高重复率论文,推出五步降重法。结合深度学习技术重构语句,保留原意的同时提升独特性,让30%的重复率迅速降至合格线。
  • 山东哪家老干烘茶品质好? - 中媒介
  • 2026 企业 AI 知识中枢与智能 BI 部署优选:知识库部署厂商 / 服务商、AI 知识库方案商、Deepseek 部署服务商、BI 私有化 / 本地部署厂商完整盘点 - 品牌2026
  • OpenClaw+Qwen3-14B科研助手:文献自动归档与摘要生成
  • AgentCgroup论文学习:AI Agent为什么需要新的OS资源控制
  • ChatGPT Plus/Pro用户必看:如何突破O1/O3模型文件识别限制与使用次数瓶颈?
  • MySQL超详细安装教程(保姆级)
  • 绍兴Geo优化服务,究竟哪家更值得选?
  • 终极指南:3分钟为Android Studio添加中文界面,告别英文困扰
  • 终极网盘直链解析方案:八大平台全速下载实战指南
  • 终极指南:如何恢复B站经典旧版界面 - 让你的Bilibili重回怀旧时代
  • KH Coder完全指南:5步零代码实现专业文本挖掘,让数据自己说话
  • Z-Image-Turbo-rinaiqiao-huiyewunv开发者案例:基于Z-Image Turbo的定制化角色生成工具开发
  • Ubuntu:在docker中执行OpenHarmoyOS的hb相关命令报错Exception(“Please call hb utilities inside source root directo
  • Python 中的 Map 和 Reduce 详解