El Explorador de API de Google es una herramienta disponible en la mayoría de las páginas de documentación de los métodos de la API de REST que te permite probar los métodos de la API de Google sin escribir código. El Explorador de API actúa sobre los datos reales, así que ten cuidado cuando pruebes métodos que crean, modifican o borran datos.
Usar el directorio
Para obtener una lista de las API de Google que puedes explorar, explora el directorio del Explorador de API de Google. Esta lista contiene vínculos a la documentación de referencia de la API para las API compatibles. Sigue estos pasos para explorar la API:
- Abra el directorio del Explorador de API de Google.
- En el cuadro de búsqueda de la parte superior, ingresa el nombre de la API que deseas explorar.
- Haz clic en el nombre de la API. Se abrirá la documentación de referencia de la API.
- A la izquierda, haz clic en el método que deseas usar en la navegación.
A la derecha, busca el panel etiquetado "Prueba este método" Consulta los detalles a continuación sobre cómo usar el panel lateral del Explorador de API y cómo expandirlo al panel Explorador de pantalla completa.
Usar el panel lateral
De forma predeterminada, el Explorador de API aparece en el lado derecho de la pantalla en la documentación de referencia de la API para los métodos compatibles.
Puedes interactuar y personalizar las siguientes secciones en el panel lateral del Explorador de API:
- Solicitar parámetros, si el método lo requiere
- Cuerpo de la solicitud, si el método lo requiere
- Credenciales, para probar el método con varios tipos y alcances de credenciales.
- Ejecutar para ejecutar el método con los parámetros y la configuración que especificaste.
- Result, que se muestra solo después de ejecutar el método.
Cómo usar el panel de pantalla completa
En el panel lateral del Explorador de API contraído, puedes hacer clic en el ícono de Pantalla completa para expandir el Explorador de API. En el panel de pantalla completa, se muestra un panel adicional que contiene muestras de código, respuestas de application/json y respuestas HTTP sin procesar.
Autenticación
El Explorador de API usa sus propias credenciales para realizar una solicitud. No puedes usar credenciales personalizadas con el Explorador de API.
Formatos de datos
El Explorador de API solo admite JSON para respuestas y cargas útiles de solicitud. Incluso si tu API admite otros formatos de datos, estos formatos no funcionan en el Explorador de API.
Próximos pasos
- Obtén información sobre cómo mostrar el Explorador de API y ejecutar un método.
- Aprende a probar un método con diferentes credenciales y alcances.
- Obtén información sobre cómo ejecutar el código de muestra del Explorador de API de forma local.