Best design, easy to use (github actions integration), includes a built-in changelog

La experiencia con su portal fue excelente, unos pocos clics con el archivo OAS, y la documentación estaba lista. Y la interfaz de usuario de la documentación es muy buena, tiene un aspecto moderno en lugar de otros generadores que tienen un aspecto clásico.

Cuando desarrollas una API REST, tu trabajo carece de una interfaz, al menos una interfaz que los humanos sean capaces de manejar. Quiero decir, una interfaz JSON dispersa en muchas URLs no es algo que venga de manera natural a los humanos. Aprovechar una especificación OpenAPI resuelve esta brecha y hace visible tu trabajo. Cuando hablo de la evolución de la especificación OpenAPI, me refiero a Bump. Bump crea tu documentación e incluso te dice cómo está evolucionando tu API a lo largo del tiempo al proporcionar un registro de cambios. Incorporar Bump en tu CI incluso puede bloquear tu lanzamiento cuando no es compatible hacia atrás. Nadie quiere cambios disruptivos no atendidos en una versión de parche. La comunicación es clave y Bump te ayuda a comunicar los cambios de tu API a tus colegas y clientes de una manera que casi no te cuesta nada en tiempo y dinero.