Java >> Java Tutorial >  >> Tag >> Spring

Swagger-Dokumentation für die Spring Boot-REST-API – Teil II

Spring

In diesem Beitrag zeigen wir, wie man Swagger-Dokumentation zur Spring Boot-Rest-API hinzufügt. Wir haben gelernt, wie man eine Spring Boot REST API erstellt. In der Welt der Microservices ist die Dokumentation Ihrer API heutzutage eine Standardnorm. Swagger bietet eine praktische Schnittstelle und eine einfache Möglichkeit, diese Dokumentationen zu erstellen, die jeder Kunde jederzeit testen kann. Sie müssen nicht alle Dienste in ihrer Umgebung haben.

Was ist Swagger?

Swagger sollte eine standardmäßige, sprachunabhängige Schnittstelle zu REST-APIs bereitstellen, die es jedem ermöglicht, die Fähigkeiten eines Dienstes ohne Quellcode und Dokumentation des Quellcodes zu verstehen. Weitere Einzelheiten zu Swagger finden Sie hier.

Wie füge ich Swagger-Dokumentation hinzu?

In unserem vorherigen Post haben wir die Spring Boot REST API hinzugefügt. Wir werden Swagger derselben REST-API hinzufügen.

  1. Maven-Abhängigkeiten hinzufügen

Zunächst fügen wir Maven-Abhängigkeiten für Swagger-Jars hinzu.

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.6.1</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.6.1</version>
<scope>compile</scope>
</dependency>

2. Swagger Bean zur Konfiguration hinzufügen

In unserer Hauptstartanwendungsklasse werden wir einige Konfigurationen hinzufügen, um eine Bean einzurichten, die mit Prahlerei umgeht. Im folgenden Code zeige ich, was ich in Application.java hinzugefügt habe die Datei. Im Grunde haben wir eine neue Bean vom Typ Docket erstellt die sich um die Swagger-Konfiguration kümmert.

@EnableSwagger2
@SpringBootApplication(scanBasePackages = { "com.betterjavacode.benefits" })
public class Application {

public static void main(String[] args) {
 SpringApplication.run(Application.class, args);

}

@Bean
 public Docket benefitsApi() {
 return new Docket(DocumentationType.SWAGGER_2).groupName("Benefits")
 .apiInfo(apiInfo())
 .select()
 .apis(RequestHandlerSelectors.any())
 .paths(PathSelectors.any())
 .build()
 .pathMapping("/");

}

private ApiInfo apiInfo() {
 return new ApiInfoBuilder().title("Benefits REST Service")
 .description(" A simple REST service for Benefits software ")
 .contact(new Contact("Yogesh Mali", "https://betterjavacode.com/", ""))
 .version("1.0")
 .build();
 }
}

3. Swagger-Dokumentation anzeigen

Jetzt, nachdem wir die Konfiguration hinzugefügt haben, können wir unser Projekt mit Maven Clean Install erstellen. Führen Sie nach einem erfolgreichen Build das Projekt von Eclipse als Java-Anwendung aus. Wir werden auf die Swagger-Dokumentation von URL http://localhost:8080/swagger-ui.html zugreifen . Dies sieht wie folgt aus:

Quellcode für diesen Beitrag ist verfügbar unter Spring-boot-rest-api-with-swagger.

Schlussfolgerung

In diesem Beitrag habe ich gezeigt, wie Sie Swagger-Dokumentation für Ihre Spring Boot-basierte REST-API hinzufügen können.


Java-Tag