Wie verbinde ich einen Swagger mit einem Spring Boot-Projekt - Prozess und Setup

Die Entwicklung von Webanwendungen mit Spring Boot ist in der heutigen Welt der Softwareentwicklung populär geworden. Bei der Entwicklung komplexer Projekte ist jedoch häufig eine praktische Dokumentation und Visualisierung der API erforderlich. Swagger ist eines der beliebtesten Tools zum Dokumentieren und Testen von APIs. Die Verbindung von Swagger zu einem Spring Boot-Projekt vereinfacht die API-Entwicklung und -Tests erheblich und verbessert die Lesbarkeit.

Swagger bietet eine Reihe von Tools, mit denen Sie aktuelle und vollständige Dokumentation für die API erstellen und verwalten können. Es ermöglicht Ihnen auch, die API bequem über eine Webschnittstelle zu testen. Die Verbindung des Swaggers mit dem Spring Boot-Projekt erfolgt durch zusätzliche Abhängigkeiten und das Konfigurieren der entsprechenden Klassen.

Das Verbinden des Swaggers mit einem Spring Boot-Projekt beginnt mit dem Hinzufügen der erforderlichen Abhängigkeit zur POM-Datei.xml. Fügen Sie dazu den folgenden Code hinzu:

Dadurch werden dem Projekt die erforderlichen Swagger-Klassen und -Funktionen hinzugefügt. Nachdem Sie die Abhängigkeit hinzugefügt haben, müssen Sie den Swagger in der Spring Boot-Konfigurationsklasse konfigurieren. Erstellen Sie dazu eine SwaggerConfig-Klasse oder eine ähnliche Klasse und kommentieren Sie sie mit der @Configuration-Annotation. Übergeben Sie dann die erforderlichen Parameter an die Docket-Funktion.swagger2().

Der Prozess, den Swagger mit einem Spring Boot-Projekt zu verbinden

1. Fügen Sie der pom-Datei eine Swagger-Abhängigkeit hinzu.xml:

io.springfoxspringfox-boot-starter3.1.2

import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;import springfox.documentation.builders.ApiInfoBuilder;import springfox.documentation.builders.PathSelectors;import springfox.documentation.builders.RequestHandlerSelectors;import springfox.documentation.service.ApiInfo;import springfox.documentation.spi.DocumentationType;import springfox.documentation.spring.web.plugins.Docket;import springfox.documentation.swagger2.annotations.EnableSwagger2;@Configuration@EnableSwagger2public class SwaggerConfig private ApiInfo apiInfo() >

Schritt 1: Hinzufügen von Abhängigkeiten und Anpassen des Projekts

Bevor Sie den Swagger mit dem Spring Boot-Projekt verbinden können, müssen Sie der pom-Datei mehrere Abhängigkeiten hinzufügen.xml. Öffnen Sie dazu diese Datei in Ihrem Projekt und fügen Sie die folgenden Zeilen hinzu:

1. Hinzufügen von Abhängigkeiten:

2. Einrichten eines Projekts:

Öffnen Sie die Klasse Ihrer Anwendung, die die main–Methode enthält, und fügen Sie die Annotation @EnableSwagger2 hinzu, bevor Sie Ihre App-Klasse deklarieren. Diese Anmerkung teilt Spring Boot mit, dass Swagger in Ihrem Projekt aktiviert werden muss.

public class YourApplication

public static void main(String[] args)

Jetzt wurden Ihre Abhängigkeiten hinzugefügt und die Anwendung wurde für die Arbeit mit Swagger konfiguriert. Fahren Sie mit dem nächsten Schritt fort – Erstellen eines API-Controllers.

Schritt 2: Konfigurieren Sie den Swagger im Code

Um einen Swagger mit einem Spring Boot-Projekt zu verbinden, müssen Sie einige Schritte ausführen.

1. Fügen Sie der Datei eine Swagger-Abhängigkeit hinzu pom.xml:

2. Erstellen Sie eine Klasse SwaggerConfig und kommentiere es mit @Configuration:

public class SwaggerConfig

3. Fügen Sie eine Methode hinzu api im Unterricht SwaggerConfig und kommentiere es mit @Bean:

public Docket api()

return new Docket(DocumentationType.SWAGGER_2)

4. Gehen Sie zu Adresse http://localhost:8080/swagger-ui.html im Browser, um die Swagger UI zu sehen.

Jetzt muss der Swagger erfolgreich mit Ihrem Spring Boot-Projekt verbunden sein und Sie können ihn verwenden, um die API zu dokumentieren und zu testen.

Sie können es auch mögen

Wie man ein Geschenk in Var Tander macht

War Thunder ist ein beliebtes Online-Spiel, das viele Spieler lieben. Vielleicht hast du einen Freund, der auch ein Fan dieses Spiels ist und du willst.

Traum: Was bedeutet das Motorrad, das du willst: Traumdeutung

Träume nehmen zweifellos einen wichtigen Platz in unserem Leben ein. Sie können nur ein Spiegelbild unserer täglichen Erfahrungen sein und manchmal ein echter Schluck.

Cisco-Konfiguration: Deaktivieren der Domänennamensuche no ip domain lookup

Mit den Cisco no ip domain lookup-Befehlen können Sie die DNS-Funktion (Domain Name Lookup) auf Cisco Routern und Switches deaktivieren. Das kann sein.

Beste Leistung des Windows 7-Betriebssystems

Windows 7 war eines der beliebtesten Betriebssysteme von Microsoft, aber im Laufe der Zeit wurden die Computer leistungsfähiger und die Leistung des Betriebssystems begann.

• Feedback
• Nutzungsbedingungen
• Datenschutz