Descripción general del Portal de Cloud Endpoints

Puedes utilizar el Portal de Cloud Endpoints para crear un portal para desarrolladores, un sitio web al que puedan acceder los usuarios de tu API de Cloud Endpoints para explorar y probar tu API. En tu portal, los desarrolladores que usan tu API en su código propio pueden encontrar la documentación de referencia para la API de SmartDocs. SmartDocs usa el documento de OpenAPI que crea Cloud Endpoints Frameworks para generar documentación de referencia de la API. SmartDocs incluye un panel Prueba esta API para que los desarrolladores puedan interactuar con tu API sin salir de la documentación.

portal

También puedes proporcionar documentación personalizada propia para ayudar a los usuarios a comenzar y a que tengan éxito con tu API.

Visita la Demostración del portal de Endpoints para explorar el portal que fue creado a partir de varias muestras distintas de Endpoints.

Limitaciones

  1. Los usuarios deben autenticarse con un proyecto de GCP a fin de acceder al portal para desarrolladores. Los usuarios que no se autentiquen no podrán ver el portal para desarrolladores.
  2. El servicio de Endpoints debe ser de acceso público para poder usar el panel Prueba esta API. Las solicitudes fallarán si se configura otra autenticación (como IAP) en el servicio de Endpoints.
  3. El Portal de extremos no admite mensajes o servicios con nombres idénticos declarados en espacios de nombres separados de una sola implementación de extremos. Esto puede afectar a los usuarios que intentan seguir las prácticas recomendadas para el control de versiones de la API con extremos. Para evitar el control incorrecto de versiones de mensajes o servicios, usa uno de los siguientes enfoques:
    • Asigna un nombre único a todos los mensajes y servicios en los archivos .proto. Por ejemplo, asigna el nombre data1 al mensaje data en la versión 1, data2 en la versión 2, etcétera.
    • Separa las versiones de la API en diferentes implementaciones de Endpoints.

¿Qué sigue?