Skill 广场
API接口文档生成 Skill

API接口文档生成.Skill

@luongnv89/doc-generator

4.6优秀AI 评分基础检查通过源自 GitHub

读取后端源代码与路由定义,解析请求参数与返回值,一键生成规范的API接口文档及多语言调用示例。

编程后端开发工程师前端对接工程师技术文档工程师2026-09-28 更新main

API接口文档生成

该功能专为后端研发与接口交付设计。用户提供服务端源代码、路由文件或数据模型定义,系统自动解析各个端点的请求路径、HTTP方法、参数约束、成功与错误响应体,并生成标准Markdown文档、OpenAPI规范文件以及包含cURL、JavaScript和Python的调用示例。无需手动编写繁琐的参数表格,显著提升接口对接效率。

常见场景

它能帮你做什么?

01

新接口文档编写:提供刚写完的控制器或路由源码,自动输出带有参数校验说明和响应JSON的完整接口说明。

02

导出OpenAPI规范:扫描现有项目API端点,快速导出标准Swagger/OpenAPI文件,便于导入文档平台或Mock工具。

03

对接示例代码生成:针对特定业务端点,快速生成包含认证鉴权头部的cURL、Python及JS请求示例。

三步完成

怎么使用

1安装 Skill

把右侧安装请求发给你的 AI。

2说清楚目标

告诉 AI 你想完成什么,或直接贴入内容。

3检查结果

按需要继续调整语气、范围或格式。

复制就能用

你可以直接这样说

“请根据 controllers/user.ts 中的用户查询和更新路由,生成完整的 Markdown 接口文档。”

“将 routes/order.js 里的订单创建接口转成 OpenAPI 3.0 规范,并附带 cURL 调用示例。”

“分析 api/v1/auth.py 中的鉴权代码,补充 401 和 403 的错误响应码说明及对应参数表。”

适用人群

适合谁?

后端开发工程师前端对接工程师技术文档工程师全栈开发者

上手门槛

使用难度

简单

不需要写代码,照着示例说清楚需求即可。

兼容范围

支持哪些 AI?

Codex可直接使用
Claude Code可直接使用
OpenClaw可直接使用
Hermes可直接使用
国内 Agent可直接使用

中文用户增强

Skill Px 做了什么?

中文说明简化使用方式补充中文案例整理安装流程降低理解难度