---
title: API Probeer Dit!
slug: api-probeer-dit
description: Leer hoe om die "PROBEER DIT!"-funksie te gebruik om API's gerieflik in jou webblaaier te toets. Ontdek die nodige stappe, insluitend die invoer van API-lêers, die opstelling van verstekwaardes en die definisie van toetsparameters. Vind uit hoe om die kod
createdAt: 2023-04-26T07:38:48.000Z
---

:::hint{type="info"}
Die **PROBEER DIT!**-funksie laat u toe om u API direk in u blaaier te toets. Dit werk beide op 'n gepubliseerde dokumentasieportaal of direk binne die redigeerder.
:::

## Hoe om te konfigureer

Die **Probeer dit!**-funksie gebruik die [fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch), dus om dit te laat werk, moet u API-imports die volgende hê:

- 'n absolute pad-URL na u API (nie net 'n pad nie)
  - voeg 'n URL soos volg in u .yml-lêer by
- servers:
  - URL-voorbeeld: https\://petstore3.swagger.io/api/v3 (u werklike URL)
- magtigingsmetodes sal vanaf u api-lêer gelees en op elke API-bladsy ingesluit word
- CORS gedeaktiveer of geaktiveer vir die dokumentasiedomein, sodat gebruikers werklik u API kan toets

## Hoe dit werk

::::WorkflowBlock
:::WorkflowBlockItem
Importeer u API-lêers ([direkte import](docId\:TaIPROVD4f8rfRrKNZwss) of [github-sinkronisering](docId\:tqNHmJkL_0eGc1PQru47p))
:::

:::WorkflowBlockItem
\[Opsioneel] Definieer ["verstek"](docId\:TaIPROVD4f8rfRrKNZwss)-waardes in u OpenAPI-lêer. Op hierdie manier, wanneer u u API invoer, sal alle "default"-waardes by die kodevoorbeeld gevoeg word, en u kan u API onmiddellik toets sonder die behoefte om handmatig waardes by params te voeg.
:::

:::WorkflowBlockItem
Konfigureer die API-metode met die toetsparams

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

:::WorkflowBlockItem
Nadat u die parameters opgedateer het, sal die kodevoorbeeld aan die regterkant (of onder, afhangende van hoe u u aansig stel) ook opgedateer word met die toetsparams wat u bygevoeg het, en die kodebrokkie van die versoek in verskeie tale aan u verskaf

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

:::WorkflowBlockItem
Klik die **Probeer dit!**-knoppie en kyk na die responsarea onder die voorbeeldkode

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