Ahora puedes documentar automáticamente tus API con Cloud Endpoints
jueves, 19 de abril de 2018
Con Cloud Endpoints, nuestro servicio de compilación, implementación y administración de API en Google Cloud Platform (GCP), puedes concentrarte en la lógica y el diseño de tu API, y nuestro equipo se ocupa del resto. Hoy expandimos ese “resto” y anunciamos nuevos portales para desarrolladores en los cuales estos podrán aprender a interactuar con tu API.
Los portales para desarrolladores son lo primero que ven los usuarios cuando intentan usar tu API, y representan una oportunidad para responder muchas de sus preguntas: ¿Cómo evalúo la API? ¿Cómo obtengo código que llame a la API? Y tú, el desarrollador de la API, ¿cómo mantienes actualizada esta documentación mientras tu API se desarrolla y cambia con el paso del tiempo?
En un caso que resulta muy similar al de la autorización, la limitación de la velocidad y la supervisión, sabemos que prefieres concentrarte en tu API en lugar de la documentación. Creemos que debería ser fácil presentar un portal para desarrolladores personalizado con tu marca y contenido, y que debería ser mínimo el esfuerzo para mantener su contenido actualizado.
A continuación, te mostramos un ejemplo de un portal para desarrolladores en el caso de Swagger Petstore (YAML):
El portal incluye, de izquierda a derecha, la lista de métodos y recursos, y las páginas personalizadas que agregó el desarrollador de la API, detalles sobre el método específico de la API y una herramienta interactiva para probar la API en el momento.
Si ya usas Cloud Endpoints, puedes comenzar a crear portales para desarrolladores de inmediato si te registras para esta versión Alfa. El portal estará siempre actualizado; las especificaciones que ingreses con gcloud también se insertan en el portal para desarrolladores. Desde el portal, puedes explorar la documentación, probar las API de forma interactiva junto con los documentos y compartir el sitio con tu equipo. Puedes publicar tu dominio personalizado, para lo que proporcionamos un certificado SSL, y agregar tus propias páginas para elementos de contenido, como instructivos y guías. Lo mejor probablemente sea que este portal funciona de inmediato con gRPC y OpenAPI, por lo que tus documentos estarán siempre actualizados, independientemente del tipo de API que uses.
Comunícate con nuestro equipo si quieres probar los portales para desarrolladores de Cloud Endpoints. Tus comentarios nos ayudarán a dar forma al producto y priorizar nuevas características en los próximos meses.