De API-designer

Met de API-designer ontwerpt u een volledige API rechtstreeks in Restorm: u beschrijft uw gegevens en uw routes, Restorm regelt de rest — het bedient uw ontwerp als een echte mockserver en het genereert de code van uw applicatie op basis van templates.

Het is het ideale hulpmiddel om een API te starten voordat de back-end bestaat: schets het contract, laat het testen door uw clients en houd alles versiebeheerd in uw project.

Eén ontwerp, meerdere secties

Een ontwerp maakt u zoals elk ander element: rechtsklik op een map ▸ Toevoegen ▸ API-ontwerp. Het opent in zijn eigen tabblad en bundelt meerdere secties, bereikbaar vanuit de zijbalk:

Sectie	Waarvoor die dient
Modellen	Uw entiteiten en hun eigenschappen — zie Modellen, enums en eigenschappen.
Enums	Gesloten verzamelingen van waarden, herbruikbaar als eigenschapstype.
Routes	De toegangspunten van de API, gegroepeerd per resource — zie Routes & CRUD.
Server	Het ontwerp als mock bedienen, via HTTP, GraphQL, SOAP, OData of gRPC — zie Het ontwerp als mock bedienen.
Clients	Kant-en-klare verzoeken die de draaiende mock aanroepen — zie Clients.
Documentatie & Notities	Documentatie en vrije notities gekoppeld aan het ontwerp.
Code	Het genereren van code op basis van uw templates — zie Codegeneratie.

De instellingen van het ontwerp (naam, standaardwaarden) opent u door rechtstreeks op het ontwerpknooppunt in de zijbalk te klikken.

Het typische traject

1. Beschrijf uw gegevens — maak uw modellen en uw enums, voeg hun eigenschappen, hun types en hun beperkingen toe.
2. Definieer uw routes — met de hand, of met één klik via CRUD genereren vanuit een model.
3. Bedien de mock — start de server en richt uw applicatie of een client erop. Hetzelfde ontwerp wordt automatisch geprojecteerd in elk ingeschakeld protocol.
4. Genereer de code — kies een of meer templates (uw eigen of die van Restorm) en produceer het bijbehorende project.

Elke stap wordt uitgebreid beschreven op de pagina’s van deze sectie.