URL serveur manquante ou incorrecte dans la spécification OpenAPI
Quand cela se produit : Le bouton Essayez ! n’apparaît pas, ou les consommateurs d’API ne savent pas quelle URL de base utiliser pour leurs requêtes.
Pourquoi cela arrive : La servers section manque dans la spécification OpenAPI ou contient une URL incorrecte. Sans cela, les utilisateurs de l’API ne peuvent pas déterminer où envoyer les requêtes et les outils de documentation ne peuvent pas remplir la fonction Essayez-le !
Comment le corriger :
- Ajoutez une section correcte
serversà votre sca :
servers:
- url: https://api.yourdomain.com
description: Production
- Pour les API spécifiques à une région, définissez plusieurs entrées serveur :
servers:
- url: https://api.yourdomain.com
description: Global
- url: https://api.us.yourdomain.com
description: US region
- Assurez-vous que tous les clients API (par exemple, Postman, cURL) utilisent la bonne URL serveur lors des requêtes.
i️ NOTE
Les URL ci-dessus en sont des exemples. Utilisez l’URL de base réelle de votre API.
Corps vide indiqué dans la documentation de l’API
Quand cela se produit : Le corps de la requête d’un point de terminaison s’affiche comme vide dans la documentation publiée.
Pourquoi cela arrive : Le schéma OpenAPI est absent "type": "object" sur une ou plusieurs définitions d’objets.
Comment le corriger : Assurez-vous que chaque définition d’objet dans votre spécification OpenAPI inclut "type": "object". Cette caractéristique explique à Document360 comment afficher avec précision les paramètres du corps des requêtes et les schémas de réponse, facilitant ainsi la compréhension et l’interaction de votre API pour les développeurs.