Reseñas y detalles del producto de Stoplight

Me gusta el modo de edición de markdown. Te permite escribir tu documentación rápidamente, siempre que conozcas Markdown (lo cual es una buena inversión). No es un sistema WYSIWYG, pero serás guiado con múltiples campos de formulario.

Otra cosa buena es que tus documentos no se guardan en la aplicación, sino en uno de tus repositorios como archivos yaml estándar. Es tan poderoso y tiene dos ventajas: eres libre de llevar tu documento a cualquier parte más tarde (sin bloqueo) y puedes automatizar la generación de código (por ejemplo, puedes extraer información de otras fuentes, integrarla en los documentos y luego devolverla a Stoplight). Reseña recopilada por y alojada en G2.com.

No muchos problemas hasta ahora. Tal vez tenga los mismos problemas que puedes encontrar en herramientas similares: puedes sentirte abrumado por las opciones para cada campo o cada entrada. Pero es normal, ya que tienes que encontrar el equilibrio entre la usabilidad y las características, más cuando tienes que seguir una especificación que no depende de ti. Además, eché de menos alguna forma de documentar los webhooks de la misma manera que puedo documentar la API, pero de nuevo, probablemente sea más una limitación de OpenAPI que de Stoplight en sí. Reseña recopilada por y alojada en G2.com.

Como todos los demás, comencé con las herramientas de swagger. Pero estaba escribiendo demasiado código en YAML. Mantenerlo era un gran problema. Era un gran proyecto. Tenía que documentar al menos 100 puntos finales de API. Pensé que el proyecto tomaría al menos un par de meses, pero pude hacerlo en la mitad del tiempo. Ahorré mucho tiempo y cobré mucho menos al cliente gracias a Stoplight. Lo primero que me impresionó fue lo rápido que Stoplight Desktop hizo la documentación de API en OAS. La mayor parte del tiempo no tuve que escribir una sola línea de YAML o JSON. El código y la vista previa lado a lado fueron un salvavidas. La interfaz de usuario de la herramienta de escritorio era extraordinaria y hace que documentar APIs sea accesible para cualquiera, no solo para desarrolladores. Crear documentos de soporte de API fue sencillo gracias al soporte completo para markdown. Reseña recopilada por y alojada en G2.com.

Bueno, Stoplight es un poco lento para absorber los cambios enviados a OAS3. Hay algunas características no disponibles en Stoplight a pesar de ser parte de OAS 3 durante mucho tiempo. No recuerdo cuáles son. Reseña recopilada por y alojada en G2.com.

Me gusta la capacidad de completar rápidamente los campos del formulario en lugar de tener que escribir la estructura yaml/json a mano. También es muy agradable tener Spectral integrado directamente en la herramienta, ya que esto nos ayuda a automatizar parte del proceso de revisión de diseño al aliviar la necesidad de revisar manualmente los estándares de codificación en torno al diseño de las API. Reseña recopilada por y alojada en G2.com.

Cuando se lanzan nuevas funciones, no parecen estar completamente probadas y ocasionalmente causan problemas. También parece haber una priorización de "Lanzar nuevas funciones" por encima de "Mejorar las que existen". La implementación de Spectral es buena, pero es difícil mantener un conjunto de reglas consistente en cientos de proyectos. Reseña recopilada por y alojada en G2.com.

Es realmente intuitivo e incluso para una persona no técnica como yo, fue fácil de entender y escribir una documentación. Reseña recopilada por y alojada en G2.com.

Markdown es realmente limitado y limita la posibilidad de crear documentación más creativa. Reseña recopilada por y alojada en G2.com.

Poder cambiar entre la interfaz de usuario/YAML. Reseña recopilada por y alojada en G2.com.

Los módulos pueden parecer un poco fragmentados. Reseña recopilada por y alojada en G2.com.

Lots of functionality that is available within stoplight, easy to use and merge changes! Reseña recopilada por y alojada en G2.com.

Typically they take long to respond to issues that we face. Reseña recopilada por y alojada en G2.com.

Stoplight es una herramienta de documentación muy fácil de usar tanto para generar documentos como para que los desarrolladores consuman documentación técnica de API.

También soy fanático de sus permisos de usuario granulares que nos permiten gestionar permisos sobre qué páginas pueden ver las personas. Reseña recopilada por y alojada en G2.com.

Aunque no es una limitación en la forma tradicional de documentar las API, me gustaría tener más flexibilidad de diseño al crear páginas de personas de negocios. Reseña recopilada por y alojada en G2.com.

Me gusta que Stoplight use el formato openAPI para definir las APIs. También he podido importar los archivos de configuración a otros servicios para facilitar las pruebas de API. Reseña recopilada por y alojada en G2.com.

No me encanta que se requiera GitHub para colaborar y compartir tu trabajo. Preferiría un método de colaboración que guarde automáticamente mis cambios y le dé acceso a mi equipo para editar. Además, uso Azure DevOps día a día, pero creé una cuenta de GitHub para la colaboración en Stoplight porque era gratis. Eso me sacó de nuestro ecosistema existente. Reseña recopilada por y alojada en G2.com.

La interfaz de usuario y la conexión a Github y otros repositorios. La estructura de las carpetas y el proyecto y la pantalla para editar y agregar información son bastante simples y fáciles de usar. Reseña recopilada por y alojada en G2.com.

Personalmente, creo que la posibilidad de documentación de API impulsada por eventos o asíncrona es deficiente. Reseña recopilada por y alojada en G2.com.

La interfaz de usuario es amigable. La disponibilidad de servidores simulados automáticos facilita el proceso de prueba del diseño. Fácil de colaborar con flujos de trabajo de Git. Reseña recopilada por y alojada en G2.com.

Lo único que no me gusta es la incapacidad de mostrar la respuesta del servicio web cuando el tiempo de respuesta es superior a 10000 ms. Reseña recopilada por y alojada en G2.com.