---
title: Die invoer van OpenAPI / Swagger
slug: die-invoer-van-openapi-swagger
description: Leer hoe om die krag van OpenAPI-invoer in Archbee te benut vir ontwikkelaar-gefokusde produkdokumentasie. Ontdek die voordele, ondersteunde weergawes, verifikasiemetodes, voorafinvulling van verstekparameters en die vertoon van voorbeeldwaardes. Hierdie 
createdAt: 2021-10-29T07:42:12.000Z
---

## 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

:::hint{type="info"}
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](docId\:kmdQQMIarc8LlXomB4uUG)
:::

### Ondersteunde OpenAPI-weergawes:

Archbee ondersteun tans die volgende OpenAPI-weergawes om ingevoer te word:

1. Weergawe 2.0 en 2.0.XX
2. Weergawe 3.0 en 3.0.XX
3. Weergawe 3.1 en 3.1.XX

### Ondersteunde Auth-metodes

Archbee ondersteun tans die volgende Auth-metodes:

1. [Basiese Verifikasie](https://swagger.io/docs/specification/authentication/basic-authentication/)
2. [API-sleutels](https://swagger.io/docs/specification/authentication/api-keys/)
3. [Bearer-verifikasie](https://swagger.io/docs/specification/authentication/bearer-authentication/)

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

1. 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!](docId:3CS43Tio9p1bYEiNmXiXm) sonder om al die vereiste parameters op te dateer.

2. 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.

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/fCN8X5XLW-WFI9W1yvi3K_body-light.png)

## Hoe werk dit?

::::WorkflowBlock
:::WorkflowBlockItem
Importeer u OpenAPI-lêer deur die **Voer inhoud in** te gebruik:

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/ZIM8Bq-VEqGvv_aHHjArO_import-content-light.png)

Of gebruik die **Invoer**-opsie vanuit elke ruimte:

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/0w0sHacVm8l8N_AFkF4yf_import-option-light.png)

Of sinkroniseer u OpenAPI-lêers direk vanaf u [GitHub](docId\:tqNHmJkL_0eGc1PQru47p)-bewaarplek.

Met Archbee se [Github-integrasie](docId\:tqNHmJkL_0eGc1PQru47p) kan u u openAPI-lêers direk vanaf u repo byvoeg en sinkroniseer.
:::

:::WorkflowBlockItem
Voorskou en [toets](docId:3CS43Tio9p1bYEiNmXiXm) u ingevoerde OpenAPI

![](https://api.archbee.com/api/optimize/bNBm7nPJgXjbjLyfbHNh2/DsF_NDr8yoe62d13qJDP6_test-it-light.png)

Voorskou en toets u nuut ingevoerde OpenAPI met Archbee se [API PROBEER DIT!](docId:3CS43Tio9p1bYEiNmXiXm)-funksie.
:::

:::WorkflowBlockItem
**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](docId\:AUGmcRhWp2Y0cvjzaVom3)-opsies vir gepubliseerde portale.
:::

:::WorkflowBlockItem
Onderhou, sinkroniseer en konfigureer dit:

1. [Sinkroniseer dit handmatig](docId\:kmdQQMIarc8LlXomB4uUG)
2. [Sinkroniseer outomaties via API](docId\:kmdQQMIarc8LlXomB4uUG)
3. [Verander voorbeeldkode-taal](docId\:kmdQQMIarc8LlXomB4uUG)
:::
::::

## Hier is ’n video van hoe dit werk

::embed[]{url="https://youtu.be/LQ3nEGCcdKg"}