Ontbrekende of onjuiste server-URL in OpenAPI-specificatie
Wanneer het gebeurt: De Try It!-knop verschijnt niet, of API-gebruikers weten niet welke basis-URL ze voor hun verzoeken moeten gebruiken.
Waarom het gebeurt: De servers sectie ontbreekt in de OpenAPI-specificatie of bevat een onjuiste URL. Zonder deze functie kunnen API-gebruikers niet bepalen waar ze verzoeken naartoe moeten sturen en kunnen documentatietools de Try It!-functie niet invullen.
Hoe je het oplost:
- Voeg een juiste
serverssectie toe aan je specificatie:
servers:
- url: https://api.yourdomain.com
description: Production
- Voor regio-specifieke API's definieer je meerdere serververmeldingen:
servers:
- url: https://api.yourdomain.com
description: Global
- url: https://api.us.yourdomain.com
description: US region
- Zorg ervoor dat alle API-clients (bijvoorbeeld Postman, cURL) de juiste server-URL gebruiken bij het indienen van verzoeken.
i️ OPMERKING
De bovenstaande URL's zijn voorbeelden. Gebruik de daadwerkelijke basis-URL van je API.
Lege body getoond in de API-documentatie
Wanneer het gebeurt: Het verzoeklichaam van een endpoint wordt als leeg weergegeven in de gepubliceerde documentatie.
Waarom het gebeurt: Het OpenAPI-schema ontbreekt "type": "object" op één of meer objectdefinities.
Hoe je het oplost: Zorg ervoor dat elke objectdefinitie in je OpenAPI-specificatie . "type": "object" Deze attribuut vertelt Document360 hoe ze de parameters van de requestbody en responsschema's nauwkeurig kan weergeven, waardoor het voor ontwikkelaars gemakkelijker wordt om je API te begrijpen en ermee te communiceren.