Fehlende oder falsche Server-URL in der OpenAPI-Spezifikation
Wenn es eintritt: Der Try It!-Button erscheint nicht, oder API-Konsumenten sind unsicher, welche Basis-URL sie für ihre Anfragen verwenden sollen.
Warum es passiert: Der Abschnitt servers fehlt in der OpenAPI-Spezifikation oder enthält eine falsche URL. Ohne sie können API-Nutzer nicht bestimmen, wohin sie Anfragen senden, und Dokumentationstools können die Try It!-Funktion nicht ausfüllen.
Wie man es behebt:
- Füge deiner Spezifikation einen passenden
serversAbschnitt hinzu:
servers:
- url: https://api.yourdomain.com
description: Production
- Für regionsspezifische APIs definieren Sie mehrere Servereinträge:
servers:
- url: https://api.yourdomain.com
description: Global
- url: https://api.us.yourdomain.com
description: US region
- Stellen Sie sicher, dass alle API-Clients (zum Beispiel Postman, cURL) bei Anfragen die korrekte Server-URL verwenden.
i️ HINWEIS
Die oben genannten URLs sind Beispiele. Verwenden Sie die eigentliche Basis-URL für Ihre API.
Leerer Körper in der API-Dokumentation gezeigt
Wenn es eintritt: Der Anforderungskörper eines Endpunkts wird in der veröffentlichten Dokumentation als leer angezeigt.
Warum es passiert: Das OpenAPI-Schema fehlt "type": "object" bei einer oder mehreren Objektdefinitionen.
Wie man es behebt: Stellen Sie sicher, dass jede Objektdefinition in Ihrer OpenAPI-Spezifikation enthält "type": "object". Dieses Attribut zeigt Document360, wie man Anfrage-Body-Parameter und Antwortschemata genau darstellt, was es Entwicklern erleichtert, Ihre API zu verstehen und mit ihr zu interagieren.