3 张图片
API Doc Generator GrapesJS
免费
GrapesJS：0.22.x
包含内容
- 免费下载使用
- 支持个人与商业使用
新品
支持创作者
通过一次性或每月赞助，感谢创作者发布这款免费产品。
兼容 GrapesJS
已在 GrapesJS 0.22.x 上测试
免费下载
免费下载并用于您的项目
编辑器兼容
专为 GrapesJS 开源编辑器设计
可免费使用
可用于个人和商业项目
GrapesJS API 文档插件
将表格和表单放入 GrapesJS 画布——该插件会自动推断你的 REST API 端点，并一键生成 OpenAPI 3.1、Postman 集合和模拟数据。
推断出什么
| 画布组件 | 推断端点 |
|---|---|
| 数据表 | GET 列表 + GET 详情 + PUT 更新 + DELETE |
| 创建/编辑表单 | POST / PUT + 请求主体模式 |
| 搜索栏 | 查询参数推断 |
| 选择下拉菜单 | 枚举值提取 |
| 中文栏名/标签 | 英文字段名称（300+映射） |
一键导出
- OpenAPI 3.1 JSON
- Postman Collection JSON（直接导入 Postman）
快速入门
npm install grapesjs-plugin-apidoc import apiDocPlugin from 'grapesjs-plugin-apidoc'; grapesjs.init({ plugins: [apiDocPlugin] }); 在画布上搭建页面→点击右上角面板的 API 文档 按钮→ API 文档就准备好了。
选项
| 选项 | 类型 | 默认 | 描述 |
|---|---|---|---|
apiPrefix | string | '/api' | API路径前缀 |
btnLabel | string | 'API Docs' | 面板按钮标签 |
autoScan | boolean | false | 加载时自动扫描 |
panelId | string | 'options' | 承载按钮面板的ID |
debug | boolean | false | 控制台中的Verbose扫描输出 |
工作原理
CanvasScanner → TableAnalyzer + FormAnalyzer → APIInferrer → OpenAPI31Generator (component scan) (table / form inference) (dedupe) → PostmanGenerator → MockDataGenerator 许可
麻省理工学院