接口文档生成器 (Sunlands API Doc Generator)

一个从 Sunlands 接口平台自动生成 API 接口文档的工具，支持提取接口的详细规范信息

🎯 项目目标

自动从 Sunlands 接口平台抓取接口信息，生成包含请求方式、入参、出参规范的 Markdown 格式文档

功能特性

• 📝 API文档自动生成 (包含入参、出参规范)
• 🔗 命令行参数支持 (直接指定模块URL)
• 🏗️ Sunlands平台集成 (智能爬取接口数据)
• 📋 Markdown格式文档 (完整接口规范)

快速开始

安装依赖

方式一: 最直接 (项目内使用)

npx sfe-api-doc-generator generate https://mars.sunlands.com/\#/project/745/module/4899

方式二：本地安装 (项目内使用)

# 在项目中本地安装
npm install sfe-api-doc-generator --save-dev

# npm scripts 配置docs指令
"docs": "sfe-api-docs",

# 使用 npm scripts
npm run docs generate https://mars.sunlands.com/\#/project/745/module/4899

🏗️ 项目架构

sfe-interface-tool/
├── config/                 # 配置文件目录
│   └── mock.config.json    # 模块URL配置
├── api-docs/               # 生成的API文档
├── utils/                  # 工具模块
│   ├── apiClient.js        # 平台API客户端
│   └── puppeteerLogin.js   # 自动登录认证
├── generateDocs.js         # API文档生成脚本
└── package.json            # 项目配置

🔧 核心技术栈

• Puppeteer - 自动化登录和数据爬取
• Axios - HTTP 客户端
• Markdown - 文档格式输出

📋 使用场景

1. API文档: 自动生成接口规范文档供团队查阅
2. 接口联调: 生成标准化的接口文档规范

🔐 认证说明

系统使用企业微信扫码登录方式进行身份认证，支持会话缓存避免重复登录。

📄 许可证

MIT License - 可用于商业和个人项目