API Doc Generator GrapesJS
What's Included
- Free to download & use
- Open for personal & commercial use
Support The Creator
Use one-time or monthly support to thank the creator for this free product.
GrapesJS Compatible
Tested with GrapesJS 0.22.x
Free Download
Download and use in your projects for free
Editor Compatible
Designed for the GrapesJS open-source editor
Free to Use
Open for personal and commercial projects
GrapesJS API Doc Plugin
Drop tables and forms onto the GrapesJS canvas — the plugin infers your REST API endpoints automatically and generates OpenAPI 3.1, a Postman Collection, and mock data in one click.
What gets inferred
| Canvas component | Inferred endpoints |
|---|---|
| Data table | GET list + GET detail + PUT update + DELETE |
| Create / edit form | POST / PUT + request body schema |
| Search bar | Query parameter inference |
| Select dropdown | Enum value extraction |
| Chinese column names / labels | English field names (300+ mappings) |
One-click export
- OpenAPI 3.1 JSON
- Postman Collection JSON (imports straight into Postman)
Quick start
npm install grapesjs-plugin-apidoc import apiDocPlugin from 'grapesjs-plugin-apidoc'; grapesjs.init({ plugins: [apiDocPlugin] }); Build your page on the canvas → click the API Docs button in the top-right panel → your API documentation is ready.
Options
| Option | Type | Default | Description |
|---|---|---|---|
apiPrefix | string | '/api' | API path prefix |
btnLabel | string | 'API Docs' | Panel button label |
autoScan | boolean | false | Scan automatically on load |
panelId | string | 'options' | ID of the panel hosting the button |
debug | boolean | false | Verbose scan output in the console |
How it works
CanvasScanner → TableAnalyzer + FormAnalyzer → APIInferrer → OpenAPI31Generator (component scan) (table / form inference) (dedupe) → PostmanGenerator → MockDataGenerator License
MIT
Questions & Answers
No questions yet. Have something to ask?
Common problems this plugin can help fix
Real community questions on the same topic — see how others worked around them.