data - Documentación de Spring REST API utilizando Swagger
springfox-swagger-ui (5)
Actualmente no hay un módulo Spring MVC swagger disponible (al menos de Wordnik) pero, en general, habilitar swagger en un servicio REST basado en JVM es bastante simple.
El soporte del servidor Swagger se divide en dos partes: el servidor central y la integración con el servicio REST. Ver el Swagger github repo . Swagger core define el documento que representa el servicio REST, los parámetros, los valores permitidos, las operaciones HTTP, etc. La integración del servidor conecta este documento a la estructura del marco REST. Wordnik usa Jersey a través de JAX-RS y lanzó swagger-jaxrs para hacer esta integración. También hay un módulo Swagger-Play que se lanzará al repositorio del módulo Play en breve.
Si desea habilitar swagger en otro marco REST (como Spring MVC), siga estos pasos:
1) Genere un lector de API para generar un objeto com.wordnik.swagger.core.Documentation. Consulte la versión JAX-RS y la de play .
2) Cree un punto final REST que devuelva una versión JSON / XML del objeto Documentation al cliente. De nuevo, JAX-RS y play .
3) Agregue un filtro para interceptar solicitudes para imponer el acceso de recursos o nivel de objeto.
En resumen, podría armarse con bastante facilidad.
Estoy buscando una herramienta que podría ayudarme a generar la documentación RESTful API. Mi servidor está escrito en Java y usa el framework Spring MVC. No tengo VIEWS en mi servidor. Es un servicio 100% RESTful y todo lo que hace es consumir JSON y escupe JSON.
Me preguntaba si Swagger es compatible con las anotaciones de Spring.
Hay una implementación Swagger-SpringMVC en progreso github.com/martypitt/swagger-springmvc y ejemplos here .
La especificación v1.2 está completamente implementada y es compatible (es decir, se generan modelos, con soporte completo para genéricos), y está en desarrollo activo.
Otra implementación de Swagger for Spring MVC es swagger4spring-web .
Es similar a Swagger-SpringMVC y es compatible con todas las anotaciones Swagger y genera el esquema JSON para los tipos y parámetros de devolución. También funciona sin anotaciones de arrogancia.
Si solo después de generar un documento API interactivo (sin la necesidad de colaboración de estilo wiki), los documentos de E / S serían una mejor solución que requiere mucho menos esfuerzo de configuración, uso y personalización, en mi humilde opinión.
Se ejecuta en nodejs y Redis. Solo necesita escribir un esquema JSON de su API y genera un sitio HTML / JS que describe su API y permite a los desarrolladores jugar en vivo desde su navegador.
Planeo alojar mi API en mi servidor (como requerir que alguien instale otros 2 softwares solo para ver que la API sería una locura) pero el esquema JSON en sí ya tiene una buena estructura legible y compacta que creo que sería suficiente para la colaboración con otros programadores. Es un proyecto pequeño.
Hay una pregunta similar que quizás desee verificar.
Swagger 2.0 es la última versión de Swagger.
Hay diferentes variaciones de Swagger ahora disponibles para diferentes necesidades.
io.swagger es el paquete para las bibliotecas de fanfarronadas y necesitas frascos de primavera separados para acoplarlo con Spring. Esta es la versión 2 de fanfarronería.
io.springfox es Springfox Swagger2, en el que swagger viene integrado con Spring.
com.mangofactory es swagger integrado con Spring Web MVC framework.