Cloud Endpoints para OpenAPI

Cloud Endpoints es un sistema de administración de API que te ayuda a asegurar, supervisar, analizar y configurar cuotas en tus API mediante la misma infraestructura que usa Google para las suyas. Endpoints trabaja con el proxy de servicio extensible (ESP) y el proxy de servicio extensible V2 (ESPv2) para proporcionar administración de API. Puedes obtener más información sobre Endpoints, el ESP y el ESPv2 en Acerca de Endpoints.

Endpoints es compatible con la versión 2 de la OpenAPI Specification(antes conocida como Swagger spec); el estándar de la industria para definir las API de REST. Si no conoces la OpenAPI Specification, consulta la Descripción general de OpenAPI.

En este conjunto de documentación, se indica cómo usar Endpoints con OpenAPI. Para ver documentos sobre las otras opciones de Endpoints, consulta Todos los documentos de Endpoints.

Para comenzar, recomendamos seguir la siguiente ruta de documentos:

  1. Para ver las características de Endpoints en acción, sigue la Guía de inicio rápido de Cloud Endpoints que utiliza secuencias de comandos para implementar una API de muestra en el entorno de App Engine Flexible.

  2. Ahora, debes elegir la plataforma de computación que quieres usar para tu API. Puedes consultar la página Elige una opción de computación y consultar la sección Plataformas de computación compatibles de este artículo a modo de ayuda.

  3. Una vez que elegiste el backend para tu API, sigue un instructivo sobre tu plataforma de computación preferida.

Plataformas de computación compatibles

Endpoints para OpenAPI depende de un ESP o un ESPv2 para la administración de API. Tanto el ESP como el ESPv2 son proyectos de código abierto al que puedes acceder de estas formas:

  • Un contenedor en Artifact Registry
  • Código fuente en GitHub.
    • Para obtener detalles sobre cómo compilar el ESP, consulta el archivo ESP README.
    • Para obtener detalles sobre cómo compilar ESPv2, consulta el archivo ESPv2 README.

Puedes ejecutar el contenedor de ESP en cualquiera de estas opciones:

Puedes ejecutar el contenedor de ESP en cualquiera de estas opciones:

  • App Engine
  • Funciones de Cloud Run
  • Cloud Run
  • Knative serving
  • GKE
  • Compute Engine
  • Kubernetes

Consulta Acerca de Cloud Endpoints para obtener más información.

En el entorno flexible de App Engine, ESP se implementa de forma automática cuando agregas algunas líneas a tu archivo app.yaml. Para obtener más información, consulta Implementa tu API y ESP. ESPv2 no es compatible con el entorno flexible de App Engine.

Para el entorno estándar de generación 1 de App Engine, debes usar Endpoints Frameworks. Si, en cambio, implementas el contenedor en una de las opciones de cómputo anteriores, puedes usar el proxy de cualquier generación del entorno de ejecución de App Engine.