springfox

Springfox

Build-Status	Abdeckung	Code-Analyse

Sonarwolke

Um

Weitere Informationen zu diesem Projekt finden Sie auf der Springfox-Website oder unter http://springfox.github.io/springfox/.

Nützliche Links

• Referenzdokumentation
• Beispiel-Repository
• Beitragsrichtlinien
• Hauptmitwirkende
• Entwicklungs- und Beitragsrichtlinien
• Änderungsprotokoll
• Entwicklungsumgebung
• Freigabeanweisungen

Erste Schritte

Für neue Projekte

Für Maven

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

Für Gradle

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

Migration von einem früheren Snapshot

Spring Boot-Anwendungen

HINWEIS: Ich würde mich über Feedback freuen, um dies zu verbessern

1. Entfernen Sie explizite Abhängigkeiten von springfox-swagger2
2. Entfernen Sie alle @EnableSwagger2... Anmerkungen
3. Fügen Sie die Abhängigkeit springfox-boot-starter hinzu
4. Springfox 3.x entfernt Abhängigkeiten von Guava und anderen Bibliotheken von Drittanbietern (noch nicht Zero Dep! Hängt vom Spring-Plugin und offenen API-Bibliotheken für Annotationen und Modelle ab). Wenn Sie also Guava-Prädikate/-Funktionen verwendet haben, müssen diese auf Java 8-Funktionsschnittstellen umgestellt werden .

Migration von der vorhandenen 2.x-Version

Spring Boot-Anwendungen

HINWEIS: Ich würde mich über Feedback freuen, um dies zu verbessern

1. Entfernen Sie explizite Abhängigkeiten von springfox-swagger2
2. Entfernen Sie die @EnableSwagger2 Anmerkungen
3. Fügen Sie die Abhängigkeit springfox-boot-starter hinzu
4. Springfox 3.x entfernt Abhängigkeiten von Guava und anderen Bibliotheken von Drittanbietern (noch nicht Zero Dep! Hängt vom Spring-Plugin und offenen API-Bibliotheken für Annotationen und Modelle ab). Wenn Sie also Guava-Prädikate/-Funktionen verwendet haben, müssen diese auf Java 8-Funktionsschnittstellen umgestellt werden
5. Wenn Sie WebMvc verwenden, aber noch nicht die Annotation @EnableWebMvc verwenden, fügen Sie diese Annotation hinzu.

Regelmäßige Frühlings-MVC

HINWEIS: Ich würde mich über Feedback freuen, um dieses Erlebnis zu verbessern

1. Entfernen Sie explizite Abhängigkeiten von springfox-swagger2
2. Fügen Sie @EnableOpenApi für die offene API hinzu (und @EnableSwagger2WebMvc oder @EnableSwagger2WebFlux für ältere Versionen).
3. Die springfox-oas -Bibliothek wurde hinzugefügt
4. Springfox 3.x entfernt Abhängigkeiten von Guava und anderen Bibliotheken von Drittanbietern (noch nicht Zero Dep! Hängt vom Spring-Plugin und offenen API-Bibliotheken für Annotationen und Modelle ab). Wenn Sie also Guava-Prädikate/-Funktionen verwendet haben, müssen diese auf Java 8-Funktionsschnittstellen umgestellt werden

Lizenz

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

Lizenziert unter der Apache-Lizenz, Version 2.0 (die „Lizenz“); Sie dürfen diese Datei nur in Übereinstimmung mit der Lizenz verwenden. Sie können eine Kopie der Lizenz unter apache.org/licenses/LICENSE-2.0 erhalten

Sofern nicht durch geltendes Recht vorgeschrieben oder schriftlich vereinbart, wird die im Rahmen der Lizenz vertriebene Software „WIE BESEHEN“ und OHNE GEWÄHRLEISTUNGEN ODER BEDINGUNGEN JEGLICHER ART, weder ausdrücklich noch stillschweigend, vertrieben. Die spezifische Sprache, die die Berechtigungen und Einschränkungen im Rahmen der Lizenz regelt, finden Sie in der Lizenz.

Lizenz