OpenAPI- / Swagger-tuonti
Tämä on Restormin kattavin tuonti. Kolme versiota tunnistetaan: Swagger 2.0, OpenAPI 3.0 ja OpenAPI 3.1.
Tuonti
Section titled “Tuonti”Tiedosto ▸ Tuo (Ctrl+I) ja sitten swagger.json- tai
openapi.json-tiedosto tai suoraan määrityksen URL.
Jos URL vastaa koodilla 401 tai 403, Restorm tarjoaa mahdollisuutta liittää
todennus ja yrittää uudelleen poistumatta tuonti-ikkunasta.
Mitä tuodaan
Section titled “Mitä tuodaan”| Määrityksen elementti | Mitä Restorm tekee siitä |
|---|---|
servers (tai host + basePath + schemes) | Ympäristön perus-URL, palvelinmuuttujat ratkaistuina |
tags | Yksi kansio kutakin tunnistetta kohti sekä kansio Other lopuille |
| Jokainen operaatio | HTTP-pyyntö metodeineen ja polkuineen |
| Parametrit | Polku-, kysely- ja otsakeparametrit tyypitettyinä (merkkijono, numero, päivämäärä ja aika, luettelotyyppi, salaisuus…) |
requestBody | Sisältö omassa sisältötyypissään |
examples | Sisältö esitäytettynä annetulla esimerkillä |
components / definitions | API-dokumentaatio: mallit ja kuvaukset |
enum | Luettelotyypit, jotka ovat uudelleenkäytettävissä arvotyyppinä |
| Vastaukset | Dokumentoituina sisältötyypeittäin |
$ref-viittaukset ratkaistaan, myös komponenttien läpi.
Rivi components / definitions ansaitsee korostuksen: tuonti ei rajoitu
pyyntöihin, vaan se säilyttää API:n koko dokumentaation — kuvaukset,
mallit, tietoturvaskeemat, esimerkit ja luettelotyypit. Se on luettavissa sekä
tuonnista syntyneen muuttujakansion että jokaisen pyynnön Docs-välilehdellä,
ja se synkronoidaan uudelleen lähteestä. Katso
Tuodun API:n dokumentaation käyttö ja päivitys.
Tietoturva
Section titled “Tietoturva”Ilmoitetut tietoturvaskeemat käännetään valmiiksi kytketyiksi otsakkeiksi tai parametreiksi, ja vastaava ympäristömuuttuja luodaan puolestasi:
| Skeema | Mitä Restorm asettaa |
|---|---|
apiKey otsakkeessa tai kyselyssä | Skeeman mukaan nimetty pari, arvo {{<schema>}} |
http + basic | Authorization: Basic {{<schema>_credentials}} |
http + bearer, oauth2, openIdConnect | Authorization: Bearer {{<schema>_token}} |
Jäljelle jää vain muuttujan täyttäminen — tai sen korvaaminen todennusreitillä, jolloin saat automaattisen uusimisen.
Päivittäminen
Section titled “Päivittäminen”OpenAPI ja Swagger kuuluvat uudelleen synkronoitaviin muotoihin: kansion Päivitä-painike hakee lähteen ja Restorm soveltaa erotuksen — uudet operaatiot lisätään, kadonneet operaatiot merkitään vanhentuneiksi sen sijaan että ne poistettaisiin, ja muutoksesi säilyvät. Katso Päivitys lähteestä.