À propos des descriptions d’OpenAPI
OpenAPI est une spécification standard pour décrire les API REST. Les descriptions OpenAPI permettent aux humains et aux machines de découvrir les fonctionnalités d’une API sans avoir à lire d’abord la documentation ou à comprendre l’implémentation. GitHub a rendu son API REST publiquement disponible en tant que document conforme OpenAPI 3.0.
Obtention de la description OpenAPI GitHub
Vous trouverez la description dans le dépôt open source REST API OpenAPI Description.
Nous fournissons la description dans deux formats. La version en bundle fonctionne dans la plupart des situations, car elle inclut des composants OpenAPI pour la réutilisation et la lisibilité. Si votre outil ne prend pas en charge les références inline aux composants, nous fournissons également une version entièrement déréférencée.
Utilisation de la description OpenAPI GitHub
Une description OpenAPI peut être utilisée de nombreuses façons. Par exemple, vous pouvez :
- Générer votre propre client d’API.
- Valider et tester une intégration d’API REST GitHub.
- Explorer et interagir avec l’API REST GitHub à l’aide d’outils tiers, comme Insomnia ou Postman.
Par exemple, GitHub utilise la description OpenAPI REST pour générer la documentation de référence de l’API REST GitHub.