OpenAPI:n / Swaggerin tuonti
Miksi käyttää OpenAPI-tuontia?
Jos tuotteenne on rakennettu kehittäjille tai tuotteellanne on API, tarvitsette erinomaista tuotedokumentaatiota — muuten ette tavoita kehittäjiä.
Kun tuotte OpenAPI-tiedostonne, Archbee lukee sen, muuntaa sen näyttäväksi käyttöliittymäksi ja valmistelee sen seuraaviin käyttötarkoituksiin:
- Julkisesti jaettu (mukautetulla verkkotunnuksella)
- Sisäisesti kollegoidenne ja tiimienne kanssa
Tuonnin jälkeen voitte synkronoida, päivittää ja testata OpenAPI-määritystänne. Katso lisätiedot alla olevista osioista.
Säännöt ja oletusasetukset
Tuotuja OpenAPI-tiedostoja ei voi muokata manuaalisesti Archbee:ssa.
OpenAPI-määrityksenne päivittämiseksi ja ylläpitämiseksi tutustukaa synkronointiasetukset
Tuetut OpenAPI-versiot:
Archbee tukee tällä hetkellä seuraavien OpenAPI-versioiden tuontia:
- Versio 2.0 ja 2.0.XX
- Versio 3.0 ja 3.0.XX
- Versio 3.1 ja 3.1.XX
Tuetut Auth-menetelmät
Archbee tukee tällä hetkellä seuraavia Auth-menetelmiä:
Jos tuotte OpenAPI-tiedostoja, joissa käytetään muita Auth-menetelmiä, ne tuodaan oikein, mutta Auth-menetelmä ohitetaan.
Tämä tarkoittaa, että saatte koko Archbee OpenAPI -kokemuksen paitsi Try It! -ominaisuuden, jos päätepisteenne vaatii Auth-menetelmän, jota ei ole yllä olevassa luettelossa.
Muut
- Jos määritätte OpenAPI-määrityksessänne "oletus"-parametreja ja annatte niille arvon, koodiesimerkki ja parametrikenttä esitäytetään automaattisesti kyseisellä arvolla. Tämä helpottaa käyttäjiänne tai asiakkaitanne testaamaan API:a Kokeile! -toiminnolla ilman, että kaikkia vaadittuja parametreja tarvitsee päivittää.
- Jos määritätte OpenAPI-määrityksessänne "esimerkki"-parametrin, esimerkkiarvo näytetään vasemmalla puolella heti API-parametrin alapuolella. Tämä helpottaa käyttäjiänne tunnistamaan, millaista syötettä kyseinen parametri tarvitsee.
Miten se toimii?
Tuo OpenAPI-tiedostosi käyttämällä Tuo sisältö:
Tai käytä Tuo-vaihtoehtoa jokaisessa tilassa:
Tai synkronoi OpenAPI-tiedostosi suoraan GitHub-repositoriostasi.
Archbee:n Github-integraatio avulla voit lisätä ja synkronoida openAPI-tiedostosi suoraan repositoriostasi.
Esikatsele ja testaa tuomasi OpenAPI
Esikatsele ja testaa juuri tuomasi OpenAPI Archbee:n API KOKEILE SITÄ!-ominaisuudella.
Julkaise tai jaa se kollegoidesi tai asiakkaidesi kanssa!
Julkaise se Preview-tilaan tai Custom Domainiin ja tee siitä saatavilla kollegoillesi, tiimeillesi tai käyttäjillesi.
Jos haluat suojata sisällön ja jakaa sen vain valituille henkilöille, tutustu Julkisen käytön hallinta -vaihtoehtoihin julkaistuille portaaleille.
Ylläpidä, synkronoi ja määritä se: