Swagger

In diesem Kapitel werden wir die Anwendung testen. Dazu werden wir Swagger verwenden, ein praktisches Werkzeug, das keine Installation erfordert, da es direkt in unsere Anwendung integriert ist, indem wir es als Abhängigkeit hinzufügen.

Sie müssen nicht manuell aufschreiben, was jede Ihrer Methoden tut oder welche potenziellen Antworten sie zurückgeben kann; Swagger generiert all dies automatisch basierend auf Ihrem Code und bietet eine benutzerfreundliche Oberfläche.

Mit Swagger UI können Benutzer visuell sehen, wie sie mit der API interagieren und Anfragen direkt im Browser testen können, was sowohl die Entwicklung als auch das Testen vereinfacht.

Beispiel aus der Praxis

Stellen Sie sich vor, Sie haben einen Online-Shop, der eine API zum Erstellen von Bestellungen, Hinzufügen von Artikeln zum Warenkorb, Berechnen von Versandkosten und Verarbeiten von Zahlungen bereitstellt. Entwickler, die für Ihre Kunden oder Partner arbeiten, können diese API nutzen, um ihre Anwendungen mit Ihrem System zu integrieren.

Wenn die API mit Swagger gut dokumentiert ist, werden sie leicht verstehen, wie die notwendigen Methoden aufgerufen werden, welche Parameter übergeben werden müssen und welche Antworten zu erwarten sind — ohne den Quellcode lesen oder um Klarstellungen bitten zu müssen.

Integration mit Spring Boot

Die Integration von Swagger in ein Spring Boot-Projekt ist ziemlich einfach und erfordert nur das Hinzufügen einiger weniger Abhängigkeiten und Annotationen.

Der erste Schritt besteht darin, die notwendigen Abhängigkeiten zu Ihrer pom.xml-Datei hinzuzufügen (wenn Sie Maven verwenden).

Konfiguration von Swagger

Sie können eine Konfigurationsklasse für Swagger erstellen, wenn Sie zusätzliche Parameter festlegen müssen, zum Beispiel:

SwaggerConfig


              1234567891011
            
@Configuration
public class SwaggerConfig {

    @Bean
    public GroupedOpenApi publicApi() {
        return GroupedOpenApi.builder()
                .group("spring")
                .pathsToMatch("/**")
                .build();
    }
}

Dieser Code konfiguriert Swagger für eine Spring Boot-Anwendung mithilfe einer Konfigurationsklasse, die mit @Configuration annotiert ist, was darauf hinweist, dass diese Klasse zur Konfiguration von Anwendungskomponenten verwendet wird. Im Inneren wird ein Bean mit der @Bean Annotation erstellt, die es Spring ermöglicht, seinen Lebenszyklus zu verwalten.

Der Bean gibt ein GroupedOpenApi Objekt zurück, das eine API-Gruppe namens spring über die group() Methode konfiguriert. Als nächstes gibt die pathsToMatch("/") Methode an, dass Swagger alle verfügbaren API-Pfade dokumentieren soll, und der Aufruf von build() finalisiert den Konfigurationsprozess, indem das Objekt mit den angegebenen Parametern erstellt wird.

Nach der Integration von Swagger in das Projekt können Sie auf die Dokumentation zugreifen unter:

Zusammenfassung

Swagger ist ein leistungsstarkes Werkzeug zur Dokumentation von REST-APIs, das die API-Entwicklung, Tests und Wartung viel einfacher macht.

Die Integration mit Spring Boot vereinfacht die Nutzung noch weiter, dank der automatischen Generierung von Dokumentationen und der benutzerfreundlichen Swagger UI Oberfläche zum Testen von APIs.

1. Was ist der Hauptzweck von `Swagger`?

2. Wie greift man auf die `Swagger UI` zu, nachdem sie in ein `Spring Boot`-Projekt integriert wurde?

War alles klar?

Danke für Ihr Feedback!

Abschnitt 3. Kapitel 6

Spring Boot Backend