springfox

Springfox

Statut de construction	Couverture	Analyse du code

Nuage Sonar

À propos

Pour plus d'informations sur ce projet, visitez le site Web de Springfox ou http://springfox.github.io/springfox/

Liens utiles

• Documentation de référence
• Référentiel d'exemples
• Directives de contribution
• Contributeurs principaux
• Directives de développement et de contribution
• Journal des modifications
• Environnement de développement
• Instructions de sortie

Commencer

Pour les nouveaux projets

Pour Maven

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

Pour Gradle

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

Migration à partir d'un instantané précédent

Applications de démarrage de printemps

REMARQUE : j'aimerais recevoir des commentaires pour améliorer cela

1. Supprimer les dépendances explicites sur springfox-swagger2
2. Supprimez toutes les annotations @EnableSwagger2...
3. Ajouter la dépendance springfox-boot-starter
4. Springfox 3.x supprime les dépendances sur Guava et d'autres bibliothèques tierces (pas encore de dépôt nul ! Dépend du plugin Spring et des bibliothèques API ouvertes pour les annotations et les modèles), donc si vous avez utilisé des prédicats/fonctions Guava, ceux-ci devront passer aux interfaces de fonctions Java 8. .

Migration à partir d'une version 2.x existante

Applications de démarrage de printemps

REMARQUE : j'aimerais recevoir des commentaires pour améliorer cela

1. Supprimer les dépendances explicites sur springfox-swagger2
2. Supprimez les annotations @EnableSwagger2
3. Ajouter la dépendance springfox-boot-starter
4. Springfox 3.x supprime les dépendances sur Guava et d'autres bibliothèques tierces (pas encore de dépôt nul ! Dépend du plugin Spring et des bibliothèques API ouvertes pour les annotations et les modèles), donc si vous avez utilisé des prédicats/fonctions Guava, ceux-ci devront passer aux interfaces de fonctions Java 8.
5. Si vous utilisez WebMvc mais que vous n'utilisez pas encore l'annotation @EnableWebMvc , ajoutez cette annotation.

MVC à ressort régulier

REMARQUE : j'aimerais recevoir des commentaires pour améliorer cette expérience.

1. Supprimer les dépendances explicites sur springfox-swagger2
2. Ajoutez @EnableOpenApi pour l'API ouverte (et @EnableSwagger2WebMvc ou @EnableSwagger2WebFlux pour les anciennes versions)
3. Ajout de la bibliothèque springfox-oas
4. Springfox 3.x supprime les dépendances sur Guava et d'autres bibliothèques tierces (pas encore de dépôt nul ! Dépend du plugin Spring et des bibliothèques API ouvertes pour les annotations et les modèles), donc si vous avez utilisé des prédicats/fonctions Guava, ceux-ci devront passer aux interfaces de fonctions Java 8.

Licence

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

Sous licence Apache, version 2.0 (la « Licence » ); vous ne pouvez pas utiliser ce fichier sauf en conformité avec la licence. Vous pouvez obtenir une copie de la licence sur apache.org/licenses/LICENSE-2.0

Sauf disposition contraire de la loi applicable ou accord écrit, le logiciel distribué sous la licence est distribué « TEL QUEL », SANS GARANTIE OU CONDITION D'AUCUNE SORTE, expresse ou implicite. Consultez la licence pour connaître la langue spécifique régissant les autorisations et les limitations en vertu de la licence.

Licence