Kwaliteitsdocumentatie is belangrijk om API's gemakkelijk te begrijpen, implementeren en onderhouden. We hebben automatische productie van documentatie opgezet op basis van OpenAPI specificaties met Swagger UI en Redoc, twee van de meest populaire API visualisatie tools.
Hiermee kunt u ontwikkelaars voorzien van een interactieve interface waar u de structuur van methoden kunt leren, vragen kunt testen en snel verbinding kunt maken met uw API.
Wat is opgenomen in de documentatie
| Artikel 4, lid 1, onder a), van de VKV | Beschrijving |
|---|---|
| Eindpunten en methoden | Volledige lijst van routes, HTTP-methoden, parameters, headers |
| Voorbeeldaanvragen/antwoorden | Scripts for curl, Postman, JavaScript, Python en andere talen |
| Vergunningverlening | Ondersteuning voor JWT, OAuth2, API-sleutel rechtstreeks vanaf de interface |
| Faciliteitsdiagrammen | Beschrijving van modellen, geneststructuren en gegevensvereisten |
| Foutcodes | Alle mogelijke statussen met uitleg |
De tools die we gebruiken
Swagger UI - interactieve documentatie in de browser, met de mogelijkheid om te testen
Redoc is een leesbare, statische interface ideaal voor het publiceren op de site
OpenAPI 3. 0/3. 1-The BOM-formaat waarop alles gebaseerd is
Automatische generatie van code - annotaties, beschrijvingen, versies en documentatie updates automatisch
Exporteren naar JSON/YAML/HTML
Voordelen voor team en partners
Versnellen van onboarding van nieuwe ontwikkelaars
Integratiefouten verminderen
Altijd up-to-date, code-gesynchroniseerde documentatie
Snel beginnen met integratie zonder technische ondersteuning
Eenvoudige publicatie van documentatie op openbare of particuliere portalen
Waar vooral belangrijk
Open API's voor externe ontwikkelaars
Interne API's met actieve ontwikkeling
Platforms met B 2B-integraties en SDK's
Diensten met voorschriften en validatie van regelingen
Swagger en Redoc zijn de volgende generatie API documentatie standaard. We zullen de generatie, update en publicatie van documentatie opzetten zodat elke ontwikkelaar kan beginnen met het integreren met uw API in een kwestie van minuten.