API Doc Generator GrapesJS
Was enthalten ist
- Kostenlos heruntergeladen und nutzbar
- Offen für den privaten und gewerblichen Gebrauch
Unterstützt den Schöpfer
Nutzen Sie einmalige oder monatliche Unterstützung, um dem Ersteller für dieses kostenlose Produkt zu danken.
GrapesJS-kompatibel
Getestet mit GrapesJS 0.22.x
Kostenloser Download
Laden Sie kostenlos herunter und nutzen Sie sie in Ihren Projekten
Editor-kompatibel
Entworfen für den Open-Source-Editor GrapesJS
Kostenlos zu verwenden
Offen für private und kommerzielle Projekte
GrapesJS API Doc Plugin
Fügen Sie Tabellen und Formulare auf die GrapesJS-Leinwand ab – das Plugin erkennt automatisch Ihre REST-API-Endpunkte und generiert OpenAPI 3.1, eine Postman-Sammlung und Mock-Daten mit einem Klick.
Was wird daraus geschlossen
| Leinwandkomponente | Inferierte Endpunkte |
|---|---|
| Datentabelle | GET Liste + GET Details + PUT Update + DELETE |
| Formular erstellen / bearbeiten | POST / PUT + Anforderungskörper-Schema |
| Suchleiste | Abfrageparameter-Inferenz |
| Wähle das Dropdown-Menü aus | Enumwert-Extraktion |
| Chinesische Säulennamen / Bezeichnungen | Englische Feldnamen (300+ Abbildungen) |
Ein-Klick-Export
- OpenAPI 3.1 JSON
- Postman Collection JSON (importiert direkt in Postman)
Schneller Start
npm install grapesjs-plugin-apidoc import apiDocPlugin from 'grapesjs-plugin-apidoc'; grapesjs.init({ plugins: [apiDocPlugin] }); Erstellen Sie Ihre Seite auf der Canvas → klicken Sie auf die API-Dokumentation-Schaltfläche im oberen rechten Panel, → Ihre API-Dokumentation bereit ist.
Optionen
| Option | Typ | Default | Beschreibung |
|---|---|---|---|
apiPrefix | string | '/api' | API-Pfadpräfix |
btnLabel | string | 'API Docs' | Panel-Tastenbeschriftung |
autoScan | boolean | false | Scannen Sie automatisch beim Laden |
panelId | string | 'options' | ID des Panels, das den Knopf beherbergt |
debug | boolean | false | Verbose Scan-Ausgabe in der Konsole |
Wie es funktioniert
CanvasScanner → TableAnalyzer + FormAnalyzer → APIInferrer → OpenAPI31Generator (component scan) (table / form inference) (dedupe) → PostmanGenerator → MockDataGenerator Lizenz
MIT
Fragen & Antworten
Noch keine Fragen. Hast du etwas zu fragen?
Häufige Probleme, bei denen dieses Plugin helfen kann, zu beheben
Echte Community-Fragen zum gleichen Thema – sehen Sie, wie andere damit umgegangen sind.