Die invoer van OpenAPI / Swagger
Waarom OpenAPI-import gebruik?
As u produk vir ontwikkelaars gebou is of u produk 'n API het, benodig u uitstekende produkdokumentasie — anders kan u nie ontwikkelaars bereik nie.
Sodra u u OpenAPI-lêer invoer, sal Archbee dit lees en dit omskakel na 'n pragtige UI en dit gereed maak om:
- Publiek gedeel (op 'n pasgemaakte domein)
- Intern met u kollegas en spanne
Sodra dit ingevoer is, kan u u OpenAPI sinkroniseer, opdateer en toets. Sien meer besonderhede in die afdelings hieronder.
Reëls en verstekinstellings
Ingevoerde OpenAPI-lêers kan nie handmatig in Archbee gewysig word nie.
Om u OpenAPI op te dateer en te onderhou, kyk na ons sinkroniseeropsies
Ondersteunde OpenAPI-weergawes:
Archbee ondersteun tans die volgende OpenAPI-weergawes om ingevoer te word:
- Weergawe 2.0 en 2.0.XX
- Weergawe 3.0 en 3.0.XX
- Weergawe 3.1 en 3.1.XX
Ondersteunde Auth-metodes
Archbee ondersteun tans die volgende Auth-metodes:
As u OpenAPI-lêers met ander Auth-metodes invoer, sal hulle korrek ingevoer word, en die Auth-metode sal geïgnoreer word.
Dit beteken dat u die volledige Archbee OpenAPI-ervaring sal kry, behalwe die Try It!-funksie, as u eindpunt 'n Auth vereis wat nie in die lys hierbo is nie.
Ander
- As u 'n "verstek"-parameter in u OpenAPI definieer en u dit 'n waarde gee, sal die kodevoorbeeld en die parameterblok outomaties met daardie waarde vooraf ingevul word. Dit maak dit maklik vir u gebruikers of kliënte om u API te toets met Probeer Dit! sonder om al die vereiste parameters op te dateer.
- As u 'n "voorbeeld"-parameter in u OpenAPI definieer, sal die voorbeeldwaarde aan die linkerkant net onder die API-parameter vertoon word. Dit maak dit maklik vir u gebruikers om te identifiseer watter tipe invoer vir daardie spesifieke parameter benodig word.
Hoe werk dit?
Importeer u OpenAPI-lêer deur die Voer inhoud in te gebruik:
Of gebruik die Invoer-opsie vanuit elke ruimte:
Of sinkroniseer u OpenAPI-lêers direk vanaf u GitHub-bewaarplek.
Met Archbee se Github-integrasie kan u u openAPI-lêers direk vanaf u repo byvoeg en sinkroniseer.
Voorskou en toets u ingevoerde OpenAPI
Voorskou en toets u nuut ingevoerde OpenAPI met Archbee se API PROBEER DIT!-funksie.
Publiseer of deel dit met u kollegas of kliënte!
Publiseer dit na Preview of op ’n Custom Domain en maak dit beskikbaar vir u kollegas, spanne of gebruikers.
As u die inhoud wil beskerm en dit slegs met ’n uitgesoekte groep wil deel, kyk na ons Openbare toegangskontroles-opsies vir gepubliseerde portale.
Onderhou, sinkroniseer en konfigureer dit: