Der API-Designer
Der API-Designer lässt Sie eine vollständige API direkt in Restorm entwerfen: Sie beschreiben Ihre Daten und Ihre Routen, Restorm kümmert sich um den Rest — es stellt Ihr Design wie ein echter Mock-Server bereit und es generiert den Code Ihrer Anwendung aus Templates.
Es ist das ideale Werkzeug, um eine API zu starten, bevor das Back-End existiert: Skizzieren Sie den Vertrag, lassen Sie ihn von Ihren Clients testen und halten Sie alles in Ihrem Projekt versioniert.
Ein Design, mehrere Bereiche
Section titled “Ein Design, mehrere Bereiche”Ein Design wird wie jedes andere Element erstellt: Rechtsklick auf einen Ordner ▸ Hinzufügen ▸ API-Design. Es öffnet sich in seinem eigenen Tab und fasst mehrere Bereiche zusammen, die über die Seitenleiste erreichbar sind:
| Bereich | Wofür er dient |
|---|---|
| Modelle | Ihre Entitäten und ihre Eigenschaften — siehe Modelle, Enums und Eigenschaften. |
| Enums | Geschlossene, als Eigenschaftstyp wiederverwendbare Wertemengen. |
| Routen | Die Einstiegspunkte der API, nach Ressource gruppiert — siehe Routen & CRUD. |
| Server | Das Design als Mock bereitstellen, über HTTP, GraphQL, SOAP, OData oder gRPC — siehe Das Design als Mock bereitstellen. |
| Clients | Einsatzbereite Anfragen, die den laufenden Mock aufrufen — siehe Clients. |
| Dokumentation & Notizen | Dokumentation und freie Notizen, die dem Design angehängt sind. |
| Code | Die Codegenerierung aus Ihren Templates — siehe Codegenerierung. |
Die Einstellungen des Designs (Name, Standardwerte) öffnen sich mit einem Klick direkt auf den Design-Knoten in der Seitenleiste.
Der typische Ablauf
Section titled “Der typische Ablauf”- Beschreiben Sie Ihre Daten — erstellen Sie Ihre Modelle und Ihre Enums, fügen Sie ihre Eigenschaften, ihre Typen und ihre Einschränkungen hinzu.
- Definieren Sie Ihre Routen — von Hand oder mit einem Klick über CRUD generieren aus einem Modell.
- Stellen Sie den Mock bereit — starten Sie den Server und richten Sie Ihre Anwendung oder einen Client darauf aus. Dasselbe Design wird automatisch in jedes aktivierte Protokoll projiziert.
- Generieren Sie den Code — wählen Sie ein oder mehrere Templates (Ihre eigenen oder die von Restorm angebotenen) und erzeugen Sie das entsprechende Projekt.
Jeder Schritt wird auf den Seiten dieses Abschnitts ausführlich beschrieben.