springfox

zorro primaveral

Estado de construcción	Cobertura	Análisis de código

Nube de sonda

Acerca de

Para obtener más información sobre este proyecto, visite el sitio web de Springfox o http://springfox.github.io/springfox/

Enlaces útiles

• Documentación de referencia
• Repositorio de ejemplos
• Pautas de contribución
• Contribuyentes principales
• Pautas de desarrollo y contribución.
• Registro de cambios
• Entorno de desarrollo
• Instrucciones de lanzamiento

Empezando

Para nuevos proyectos

Para Maven

< dependency >
    < groupId >io.springfox</ groupId >
    < artifactId >springfox-boot-starter</ artifactId >
    < version >3.0.0</ version >
</ dependency >

Para Gradle

  implementation " io.springfox:springfox-boot-starter:<version> " 

Migrar desde una instantánea anterior

Aplicaciones de arranque de primavera

NOTA: Me encantaría recibir comentarios para mejorar esto.

1. Eliminar dependencias explícitas en springfox-swagger2
2. Elimine cualquier anotación @EnableSwagger2...
3. Agregue la dependencia springfox-boot-starter
4. Springfox 3.x elimina las dependencias de guava y otras bibliotecas de terceros (¡aún no tiene depósito cero! Depende del complemento Spring y de las bibliotecas API abiertas para anotaciones y modelos), por lo que si usó predicados/funciones de guava, necesitarán realizar la transición a las interfaces de funciones de Java 8. .

Migrar desde la versión 2.x existente

Aplicaciones de arranque de primavera

NOTA: Me encantaría recibir comentarios para mejorar esto.

1. Eliminar dependencias explícitas en springfox-swagger2
2. Eliminar las anotaciones @EnableSwagger2
3. Agregue la dependencia springfox-boot-starter
4. Springfox 3.x elimina las dependencias de guava y otras bibliotecas de terceros (¡aún no tiene depósito cero! Depende del complemento Spring y de las bibliotecas API abiertas para anotaciones y modelos), por lo que si usó predicados/funciones de guava, necesitarán realizar la transición a las interfaces de funciones de Java 8.
5. Si está utilizando WebMvc pero aún no utiliza la anotación @EnableWebMvc , agregue esta anotación.

Mvc de primavera regular

NOTA: Me encantaría recibir comentarios para mejorar esta experiencia.

1. Eliminar dependencias explícitas en springfox-swagger2
2. Agregue @EnableOpenApi para API abierta (y @EnableSwagger2WebMvc o @EnableSwagger2WebFlux para versiones anteriores)
3. Se agregó la biblioteca springfox-oas
4. Springfox 3.x elimina las dependencias de guava y otras bibliotecas de terceros (¡aún no tiene depósito cero! Depende del complemento Spring y de las bibliotecas API abiertas para anotaciones y modelos), por lo que si usó predicados/funciones de guava, necesitarán realizar la transición a las interfaces de funciones de Java 8.

Licencia

Copyright 2015 Marty Pitt - @martypitt, Dilip Krishnan - @dilipkrish, Adrian Kelly - @adrianbk,

Licenciado bajo la Licencia Apache, Versión 2.0 (la "Licencia"); no puede utilizar este archivo excepto de conformidad con la Licencia. Puede obtener una copia de la Licencia en apache.org/licenses/LICENSE-2.0

A menos que lo exija la ley aplicable o se acuerde por escrito, el software distribuido bajo la Licencia se distribuye "TAL CUAL", SIN GARANTÍAS NI CONDICIONES DE NINGÚN TIPO, ya sean expresas o implícitas. Consulte la Licencia para conocer el idioma específico que rige los permisos y limitaciones de la Licencia.

Licencia