Configurar Endpoints

Cloud Endpoints es compatibles con las API descritas si se usa la versión 2.0 de la especificación de OpenAPI. Describes la superficie de la API y configuras características de Endpoints como reglas de autenticación o cuotas en un documento deOpenAPI.

Endpoints hace un uso especial de los siguientes campos requeridos en tu documento de OpenAPI:

  • host
  • info.title
  • info.version
  • operationId

Esta página proporciona información sobre la forma en que Endpoints utiliza los campos anteriores. Con esta información puedes terminar de preparar tu documento de OpenAPI para su implementación.

Requisitos previos

Como punto de partida, esta página supone que ya tienes:

host

Cloud Endpoints utiliza el nombre que configuras en el campo host del documento de OpenAPI como el nombre de tu servicio.

El nombre de tu servicio de la API debe ser único en GCP. Dado que Endpoints utiliza nombres compatibles con DNS para identificar los servicios, te recomendamos que uses el nombre de dominio o de subdominio de tu API como el nombre del servicio. Según este enfoque, el nombre del servicio que aparece en la página Endpoints Services coincide con el nombre utilizado en las solicitudes para tu API.

Puedes registrar tu propio domino (por ejemplo, my-company.com) o puedes usar un dominio administrado por Google.

Usar un dominio administrado por Google

Google es el propietario y administra los dominios cloud.goog y appspot.com. Si deseas utilizar un dominio administrado por Google, debes usar el ID de tu proyecto de GCP como parte del nombre del servicio. Dado que los proyectos de GCP Console garantizan la existencia de un ID de proyecto global único, este requisito se asegura de que tengas un nombre de servicio único.

El nombre de dominio que utilices depende del backend que alojará tu API:

  • Para las API que se alojarán en el entorno flexible de App Engine, debes usar el dominio appspot.com y el nombre del servicio debe estar en el siguiente formato:

      YOUR_PROJECT_ID.appspot.com
    

    Cuando implementas tu API en App Engine, se crea automáticamente una entrada DNS con un nombre con el formato YOUR_PROJECT_ID.appspot.com.

  • Para las API que se alojarán en Compute Engine, Google Kubernetes Engine o Kubernetes, debes usar el dominio cloud.goog y el nombre del servicio debe estar en el siguiente formato:

      YOUR_API_NAME.endpoints.YOUR_PROJECT_ID.cloud.goog
    

    Para utilizar este como el nombre de dominio de la API, consulta, Configurar DNS en el dominio cloud.goog.

Usar un dominio personalizado

Si no quieres usar un dominio administrado por Google, puedes utilizar un dominio personalizado (por ejemplo, myapi.mycompany.com) para el cual tengas autorización. Antes de implementar la configuración de tu API, sigue los pasos que aparecen en Verificar la propiedad del dominio.

info.title

El panel de Endpoints muestra el texto que configuraste en el campo info.title como un nombre fácil de usar para tu API. Si tiene más de una API por proyecto de GCP, el nombre de la API se muestra en una lista la primera vez que abres el panel. Puedes hacer clic en el nombre de la API para abrir otra página que muestre las métricas, el historial de implementaciones y otra información sobre la API.

info.version

El panel de Endpoints muestra el número de versión de tu API. Antes de implementar la configuración de tu API por primera vez, te recomendamos que:

  • Configures el número de versión en el campo info.version de la versión de la API correspondiente. Por ejemplo: 1.0

  • Configura el campo basePath en el número de la versión principal. Por ejemplo: /v1

Para obtener información sobre el control de versiones de tu API, consulta administración del ciclo de vida de la API.

operationId

Aunque operationId es un campo opcional en la Especificación de OpenAPI, Endpoints solicita este número, pues se utiliza para la identificación interna de la operación. La string que usas para operationId debe ser única dentro de tu API. Consulta la descripción de operationId en la Especificación de OpenAPI para obtener orientación sobre el uso de nombres.

Pasos siguientes

¿Te ha resultado útil esta página? Enviar comentarios:

Enviar comentarios sobre...

Cloud Endpoints con OpenAPI
Si necesitas ayuda, visita nuestra página de asistencia.