API:n tuonti
Restorm tunnistaa kaksikymmentäneljä muotoa ja rakentaa niistä täyden projektipuun: kansiot, pyynnöt, ympäristöt, API-dokumentaation ja luettelotyypit.
Tämä on lähes aina paras lähtökohta: älä kirjoita pyyntöjäsi käsin, jos määritys on olemassa.
Miten tuodaan
Section titled “Miten tuodaan”Tiedosto ▸ Tuo (Ctrl+I) hyväksyy:
- tiedoston levyltä;
- URL-osoitteen — hyödyllinen verkossa tarjoiltavalle
swagger.json- tai$metadata-resurssille; - liitetyn sisällön — näin
curl-komento muutetaan pyynnöksi.
Restorm tunnistaa muodon itse: ensin tiedostopäätteen perusteella ja sitten sisältöä analysoimalla. Sinun ei tarvitse valita mitään.
Muodot
Section titled “Muodot”API-määritykset
Section titled “API-määritykset”| Muoto | Sivu |
|---|---|
| OpenAPI 3.x ja Swagger 2.0 | OpenAPI / Swagger |
| GraphQL-skeema (SDL) | GraphQL |
.proto-tiedostot ja gRPC-reflektio | gRPC |
| WSDL | SOAP / WSDL |
| AsyncAPI | AsyncAPI |
| OData EDMX / CSDL | OData |
| OpenRPC | OpenRPC |
| tRPC-skeema | tRPC |
| Smithy | Smithy |
| TypeSpec | TypeSpec |
| RAML | RAML |
| WADL | WADL |
| Thrift | Thrift |
| API Blueprint | API Blueprint |
Muiden asiakkaiden kokoelmat
Section titled “Muiden asiakkaiden kokoelmat”| Muoto | Sivu |
|---|---|
| Postman | Postman |
| Insomnia | Insomnia |
| Bruno | Bruno |
| Thunder Client | Thunder Client |
| Paw / RapidAPI | Paw |
| HTTPie | HTTPie |
VS Code REST Client (.http) | REST Client |
Kaappaukset ja komentorivit
Section titled “Kaappaukset ja komentorivit”| Muoto | Sivu |
|---|---|
| HAR (selainkaappaus) | HAR |
curl-komennot | cURL |
Invoke-RestMethod / Invoke-WebRequest | PowerShell |
Mitä saat
Section titled “Mitä saat”Lähdemuodon rikkauden mukaan:
- muuttujakansion, jossa on yksi tai useampi ympäristö ja määrityksestä poimittu perus-URL;
- kansiopuun — tunnisteittain, palveluittain tai resursseittain muodon mukaan;
- yhden pyynnön kutakin operaatiota kohti, protokollaa vastaavaa tyyppiä;
- kansioon liitetyn API-dokumentaation: mallit, kuvaukset, tietoturvaskeemat ja esimerkkivastaukset;
- määrityksen luettelotyypit, jotka ovat uudelleenkäytettävissä arvotyyppinä;
- valmiiksi kytketyt todennusotsakkeet muuttujineen — katso Todennus.
Tuonnin jälkeen jokainen avain–arvo-pari, jonka arvo ratkeaa tyhjäksi, poistetaan automaattisesti käytöstä: ensimmäinen lähetyksesi ei siis lähde tyhjien otsakkeiden parven kanssa.
Tuodun API:n dokumentaatio
Section titled “Tuodun API:n dokumentaatio”Tuonti ei tuota pelkkiä pyyntöjä: se säilyttää API:n dokumentaation — kuvaukset, mallit, tietoturvan, esimerkit ja luettelotyypit — jotka ovat luettavissa luodun kansion Docs-välilehdellä. Katso Tuodun API:n dokumentaation käyttö ja päivitys.
Tuonnin päivittäminen
Section titled “Tuonnin päivittäminen”Kaksitoista muotoa voidaan synkronoida uudelleen: Restorm vertaa lähteen uutta versiota olemassa olevaan puuhun ja soveltaa erotuksen menettämättä muutoksiasi. Katso Päivitys lähteestä.
Entä vienti?
Section titled “Entä vienti?”Restorm luo koodinpätkiä jokaiselle pyynnölle kaikilla sen protokollan kannalta olennaisilla kielillä. Katso Koodin vienti.