API-suunnittelija

API-suunnittelijan avulla suunnittelet täydellisen API:n suoraan Restormissa: kuvaat datasi ja reittisi, ja Restorm hoitaa loput — se tarjoilee suunnitelmasi kuin oikea mock-palvelin, ja se generoi sovelluksesi koodin mallien pohjalta.

Se on ihanteellinen työkalu API:n käynnistämiseen ennen kuin taustajärjestelmää on olemassa: mallinna sopimus, anna asiakkaidesi testata sitä, ja pidä kaikki versionoituna projektissasi.

Yksi suunnitelma, useita osioita

Suunnitelma luodaan kuten mikä tahansa muu elementti: oikea napsautus kansion päällä ▸ Lisää ▸ API-suunnitelma. Se avautuu omaan välilehteensä ja kokoaa yhteen useita osioita, joihin pääsee sivupalkista:

Osio	Mihin se on tarkoitettu
Mallit	Entiteettisi ja niiden ominaisuudet — katso Mallit, enumit ja ominaisuudet.
Enumit	Suljettuja arvojoukkoja, uudelleenkäytettävissä ominaisuuden tyyppinä.
Reitit	API:n sisääntulopisteet, ryhmiteltyinä resurssin mukaan — katso Reitit ja CRUD.
Palvelin	Tarjoile suunnitelma mockina protokollilla HTTP, GraphQL, SOAP, OData tai gRPC — katso Suunnitelman tarjoilu mockina.
Asiakkaat	Valmiita pyyntöjä, jotka kutsuvat käynnissä olevaa mockia — katso Asiakkaat.
Dokumentaatio & Muistiinpanot	Suunnitelmaan liitettyä dokumentaatiota ja vapaita muistiinpanoja.
Koodi	Koodin generointi malliesi pohjalta — katso Koodin generointi.

Suunnitelman asetukset (nimi, oletusarvot) avautuvat napsauttamalla suoraan suunnitelman solmua sivupalkissa.

Tyypillinen kulku

1. Kuvaa datasi — luo mallisi ja enumisi, lisää niiden ominaisuudet, tyypit ja rajoitteet.
2. Määrittele reittisi — käsin, tai yhdellä napsautuksella Generoi CRUD -toiminnolla mallista.
3. Tarjoile mock — käynnistä palvelin ja osoita sovelluksesi tai asiakas siihen. Sama suunnitelma projisoidaan automaattisesti jokaiseen käytössä olevaan protokollaan.
4. Generoi koodi — valitse yksi tai useampi malli (omasi tai Restormin tarjoamat) ja tuota vastaava projekti.

Jokainen vaihe on kuvattu yksityiskohtaisesti tämän osion sivuilla.