API-voorbeelden opstellen uit de aangeleverde documentatie
API-voorbeelden helpen een lezer de beschrijving van een endpoint te verbinden met een concrete aanvraag- en antwoordstructuur. De nauwkeurigheid hangt af van de werkelijk aangeleverde methode, velden en authenticatievereisten.
Begin met het juiste materiaal.
- Wat je aanlevert
- één API-referentiepagina met zichtbare methode, pad en schema.
- Het beoogde resultaat
- Sla voorbeeldverzoeken op met tijdelijke aanduidingen voor inloggegevens en uitsluitend gedocumenteerde velden.
Hoe de workflow werkt.
Gebruik het gedocumenteerde schema en duidelijk fictieve voorbeeldwaarden. Behoud verplichte en optionele velden en gebruik plaatshouders voor inloggegevens in plaats van echte geheimen op te nemen.
Wat je in het resultaat controleert.
Valideer het voorbeeld in de betreffende omgeving voordat je het als getest publiceert. Een aannemelijk verzoek of antwoord bewijst niet dat het endpoint bestaat of zich gedraagt zoals getoond.
Lees de tekst als een bewerkbaar resultaat en controleer hem aan de hand van de bron. Behoud belangrijke verwijzingen, namen en voorwaarden wanneer je hem naar een ander document of bericht kopieert.
Leer van het uitgewerkte voorbeeld.
Gebruik het downloadbare voorbeeld om de vorm van het resultaat te begrijpen. Vergelijk het met het bronvoorbeeld en pas dezelfde feitencontroles toe op het materiaal voor je eigen taak.
Het aangeleverde voorbeeld is ter illustratie. Het is geen vastgelegde uitvoering met jouw gegevens.
Download het voorbeeld ↓Gebruik het met je eigen materiaal.
- Open de bron waarmee je wilt werken en activeer WebAct op dat tabblad.
- Kopieer de taak uit het bovenste blok, voeg vereiste velden of voorkeuren toe en controleer de voorgestelde acties.
- Vergelijk het eerste resultaat met je bron. Vraag waar nodig om een gerichte correctie of verfijning.