L'API Discovery fournit une liste d'API Google permettant de récupérer les métadonnées du document de découverte exploitables par ordinateur pour chaque API.
Ce document est destiné aux développeurs qui souhaitent écrire des bibliothèques clientes, des plug-ins IDE et d'autres outils pour interagir avec les API Google.
Informations sur le service de découverte
Concepts
Le service de découverte des API Google repose sur deux concepts fondamentaux :
- Répertoire des API : liste de toutes les API compatibles avec le service de découverte des API. Chaque entrée du répertoire présente des informations sur une API compatible, y compris son nom, une brève description de son utilité et un lien vers la documentation. Une API peut contenir plusieurs entrées de répertoire, à raison d'une par version compatible.
- Document de découverte : description d'une API particulière, exploitable par ordinateur. Le document de découverte décrit la surface d'une version particulière d'une API. Il explique comment accéder aux différentes méthodes de chaque API via des appels HTTP RESTful. Un document de découverte comprend des descriptions des données et des méthodes associées à l'API, ainsi que des informations sur les champs d'application OAuth disponibles et des descriptions de schémas, de méthodes, de paramètres et de valeurs de paramètre disponibles.
Modèle de données
Une ressource est une entité de données individuelle disposant d'un identifiant unique. Le service de découverte des API Google fonctionne sur deux types de ressources, basés sur les concepts ci-dessus.
Liste de répertoires des API : liste des API
Chaque entrée du répertoire contient une paire nom/version d'API avec les informations suivantes :
- Informations d'identification et de description : nom, version, intitulé et description.
- Informations sur la documentation : icônes et lien vers la documentation.
- Informations sur l'état, y compris les étiquettes d'état et une indication précisant s'il s'agit ou non de la version de l'API à privilégier.
-
Lien vers le document de découverte : URI du document de découverte pour cette API, fourni en tant qu'URL complète (par exemple,
https://serviceusage.googleapis.com/$discovery/rest?version=v1).
Ressource du document de découverte : description d'une API particulière exploitable par ordinateur
En plus des informations fournies dans le répertoire des API, un document de découverte inclut également les éléments suivants :
- Schémas : liste de schémas de ressources d'API décrivant les données auxquelles vous avez accès dans chaque API. Les schémas du service de découverte des API Google sont basés sur le schéma JSON.
- Méthodes, y compris une liste des méthodes d'API et des paramètres disponibles pour chaque méthode.
- Champs d'application OAuth : identifient la liste des champs d'application OAuth disponibles pour cette API.
- Documentation intégrée : fournit de brèves descriptions des schémas, des méthodes, des paramètres et des valeurs de paramètre disponibles.
La collection unique du répertoire est le conteneur conceptuel de la ressource unique du répertoire des API et des ressources du document de découverte pour chaque API compatible.
Opérations
Vous pouvez appeler deux méthodes différentes sur les collections et les ressources du service de découverte des API Google, comme décrit dans le tableau suivant.
| Opération | Description | Mappages HTTP REST |
|---|---|---|
| liste | Répertorie toutes les API compatibles. | GET sur l'URI de la ressource de répertoire. |
Style d'appel
REST
Les opérations du service de découverte des API Google compatibles sont directement mappées au verbe HTTP GET REST, comme décrit dans la section Opérations.
Le format spécifique des URI du service de découverte des API Google est le suivant :
https://API/$discovery/rest?version=VERSION
où API est l'identifiant d'une ressource du document de découverte et VERSION l'identifiant de la version spécifique de l'API.
Voici quelques exemples de fonctionnement dans le service de découverte des API Google.
Répertoriez toutes les API compatibles avec le service de découverte des API Google :
GET https://discovery.googleapis.com/discovery/v1/apis
Essayer maintenant dans APIs Explorer
Obtenez le document de découverte pour l'API Service Usage, version 1:
GET https://serviceusage.googleapis.com/$discovery/rest?version=v1