Guías prácticas

Implementa y configura una API

• Configura Endpoints

  Explica cómo preparar tu documento de OpenAPI para la implementación en Endpoints.

• Implemente la configuración de Endpoints

  Se describe cómo implementar un documento de OpenAPI en Endpoints.

• Implemente el backend de la API

  Explica cómo implementar el proxy de servicio extensible (ESP) y el código del backend de la API.

• Implementar en Kubernetes

  Muestra cómo configurar y, luego, implementar Endpoints en Kubernetes.

• Ejecuta el ESP de forma local o en otra plataforma

  Muestra cómo configurar una instancia del ESP en una máquina local o en otro proveedor de servicios en la nube.

• Comparar los archivos de configuración

  Describe la pestaña Historial de implementaciones en la página Extremos > Servicios de la consola de Google Cloud y cómo comparar la configuración de un servicio implementado con la versión anterior.

• Obtén el nombre del servicio y el ID de configuración

  Describe cómo obtener el nombre y el ID de configuración de un servicio administrado.

Solución de problemas y supervisión

• Descripción general de la solución de problemas

  Proporciona información general sobre la solución de problemas y vínculos a otras páginas para obtener información adicional.

• Soluciona problemas en la implementación de la configuración de Cloud Endpoints

  Describe algunos errores que podrían surgir durante la implementación de la configuración de Endpoints y cómo solucionarlos.

• Cómo solucionar errores de respuesta

  Describe cómo solucionar errores que recibes de una respuesta desde una solicitud a la API.

• Solucionar errores en la implementación de App Engine Flexible

  Proporciona técnicas para solucionar problemas con las implementaciones de Endpoints en el entorno flexible de App Engine.

• Soluciona problemas en la implementación de Compute Engine

  Proporciona técnicas para solucionar problemas en las implementaciones de Endpoints en Compute Engine.

• Soluciona problemas de implementación en GKE

  Proporciona técnicas para solucionar problemas en las implementaciones de Endpoints en GKE.

• Soluciona problemas de validación de JWT

  Ofrece información de solución de problemas en caso de que la validación del JWT falle y se muestre un error como respuesta al cliente.

• Supervisar tu API

  Aquí se describe cómo supervisar el estado de las APIs con los registros y las métricas que Endpoints mantiene de forma automática.

• Haz un seguimiento de tu API

  Explica la tasa de muestreo de seguimientos, cómo estimar el costo de Cloud Trace, cómo ver los seguimientos en la consola de Google Cloud y cómo inhabilitar el muestreo de seguimientos.

Portal de Cloud Endpoints

• Descripción general del portal de Endpoints

  Proporciona una descripción general del Portal de Endpoints y, además, incluye un vínculo al sitio web de demostración del Portal de Endpoints.

• Comienza a usar el Portal de Endpoints

  Describe cómo crear un Portal de Endpoints y te presenta la interfaz de usuario del Portal de Endpoints.

• Actualizar SmartDocs

  Describe la documentación de referencia de la API de SmartDocs, cómo SmartDocs utiliza los campos en tu documento de OpenAPI para generar la documentación de la API y cómo volver a generar SmartDocs.

• Probar la API

  Describe cómo configurar el portal para que los usuarios puedan probar la API.

• Agrega documentación personalizada

  Se describe cómo cambiar la guía de introducción de ejemplo, y cómo crear y mostrar las páginas de documentación adicionales para el Portal de Endpoints.

• Sincroniza la documentación personalizada a través de una API

  Describe cómo usar una API para sincronizar la documentación personalizada con tu portal.

• Configura un dominio personalizado

  Se describe cómo configurar el Portal de Endpoints para usar un dominio personalizado.

DNS y SSL

• Verifica un nombre de dominio

  Muestra cómo verificar la propiedad de un nombre de dominio que entrega una API de Endpoints.

• Entrega una API desde tu nombre de dominio

  Muestra cómo configurar tu proyecto para entregar solicitudes de API.

• Configurar un DNS en el dominio cloud.goog

  Muestra cómo configurar los servicios de DNS para Endpoints que usan el dominio cloud.goog, del que Google es propietario y administrador.

• Entrega varias API desde un dominio

  Muestra cómo ejecutar múltiples API independientes en tu propio dominio.

• Habilita SSL con ESP

  Se muestra cómo habilitar un puerto SSL para tu servicio de Endpoints implementado mediante el ESP.

• Habilita SSL con ESPv2

  Se muestra cómo habilitar un puerto SSL para tu servicio de Endpoints implementado mediante el ESPv2.

Autenticación y claves de API

• Elige un método de autenticación

  Proporciona una descripción general y casos prácticos de muestra para cada método de autenticación compatible.

• Por qué y cuándo usar las claves de API

  Proporciona información general sobre las claves de API y cuándo usarlas.

• Usa Firebase para autenticar usuarios

  Muestra cómo configurar tu documento de OpenAPI para que el ESP valide las solicitudes entrantes de los clientes que usan Firebase a fin de autenticar usuarios.

• Usa Auth0 para autenticar usuarios

  Muestra cómo configurar tu documento de OpenAPI para que el ESP valide las solicitudes entrantes de los clientes que usan Auth0 a fin de autenticar usuarios.

• Usa tokens de ID de Google para autenticar usuarios

  Muestra cómo configurar tu documento de OpenAPI para que el ESP valide las solicitudes entrantes de los clientes que usan tokens de ID de Google a fin de autenticar usuarios.

• Usa un método personalizado para autenticar usuarios

  Muestra cómo configurar tu documento de OpenAPI para que el ESP valide las solicitudes entrantes de los clientes que usan un proveedor personalizado a fin de autenticar usuarios.

• Autenticación entre servicios

  Muestra cómo autenticar llamadas entre servicios.

• Restringe el acceso con claves de API

  Muestra cómo evitar que las aplicaciones y servicios de clientes no autorizados accedan a tu API.

Administra el acceso a la API

• Descripción general del acceso a la API

  Describe las opciones de control de acceso a las API a las que puedes acceder en Endpoints.

• Controla quién puede habilitar tu API

  Muestra cómo controlar quién puede habilitar tu API en sus propios proyectos de Google Cloud.

• Habilita una API en tu proyecto de Google Cloud

  Muestra cómo habilitar una API en un proyecto de Google Cloud.

• Otorga y revoca el acceso a la API

  Muestra cómo otorgar diferentes niveles de acceso para que otros miembros del equipo puedan ayudar a administrar la API.

Administración del ciclo de vida de la API

• Descripción general de la administración del ciclo de vida de las API

  Se describen las características de control de versiones de la API de Endpoints y se ofrecen prácticas recomendadas para el control de versiones y la etapa de pruebas de tu API de Endpoints.

• Borra una API y las instancias de la API

  Muestra cómo borrar una API y las instancias de apagado que ejecutan la API a fin de evitar costos innecesarios.

• Restablece un servicio administrado

  Se muestra cómo restablecer un servicio administrado en el caso de una eliminación accidental.

Limita las solicitudes a la API (versión beta)

• Acerca de las cuotas

  Brinda una descripción general de la funcionalidad clave proporcionada por las cuotas.

• Configura cuotas

  Describe cómo configurar cuotas para la API.

• Anula el límite de cuota predeterminado

  Describe cómo establecer un límite de cuota diferente para un proyecto de consumidor específico.

Personaliza el ESP

• Usa un nginx.conf personalizado en GKE

  Se describe cómo crear un archivo nginx.conf personalizado para implementar el ESP en GKE.

• Crea un nginx.conf personalizado para la compatibilidad con CORS

  Se muestran ejemplos de cómo se escriben las opciones de CORS de ESP en nginx.conf como punto de partida en caso de que necesites personalizar la compatibilidad con CORS en ESP.

Otras guías prácticas de Endpoints

• Migra a ESPv2

• Guías prácticas de Endpoints Frameworks para el entorno estándar de App Engine

• Guías prácticas de Cloud Endpoints para gRPC