In diesem Beitrag erfahren Sie, wie Sie OpenAPI in Ihrer Spring Boot-Anwendung konfigurieren und eine praktische Umleitung von der Root-URL zur Swagger-Benutzeroberfl?che hinzufügen. Dieses Setup verbessert Ihre API-Dokumentation und macht sie für Entwickler zug?nglicher.

OpenAPI-Bean-Konfiguration

Erstellen wir zun?chst eine Konfigurationsklasse, um unsere OpenAPI-Dokumentation anzupassen:

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.boot.info.GitProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class OpenAPIConfig {

    @Bean
    public OpenAPI customOpenAPI(GitProperties gitProperties) {
        return new OpenAPI()
                .info(new Info()
                        .title("Book Catalog API")
                        .description("REST API for managing a book catalog. Application version: "+ gitProperties.get("build.version"))
                        .version("1.0.0")
                        .contact(new Contact()
                                .name("Book Catalog Team")
                                .email("support@bookcatalog.com")
                                .url("https://github.com/vlaship/book-catalog"))
                        .license(new License()
                                .name("MIT License")
                                .url("https://opensource.org/licenses/MIT"))
                );
    }
}

Diese Konfiguration erstellt eine benutzerdefinierte OpenAPI-Bean mit grundlegenden Informationen zu Ihrer API. Sie k?nnen dies weiter anpassen, indem Sie weitere Details hinzufügen, z. B. Kontaktinformationen, Lizenz oder externe Dokumentation.
Wir k?nnen GitProperties verwenden, um weitere Details bereitzustellen.

Root-URL-Umleitungscontroller

Als n?chstes erstellen wir einen Controller, um Benutzer von der Root-URL zur Swagger-Benutzeroberfl?che umzuleiten:

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class OpenApiController {
    @GetMapping("/")
    public String index() {
        return "redirect:swagger-ui.html";
    }
}

Dieser einfache Controller verwendet ein @GetMapping für die Stamm-URL (?/“) und leitet zur Swagger-UI-HTML-Seite weiter.

application.yaml wird aktualisiert

Diese Konfigurationsdatei, oft mit dem Namen application.yml, spielt eine entscheidende Rolle bei der Definition verschiedener Aspekte des Verhaltens Ihrer Anwendung.

spring:
  application:
    name: book-catalog
    version: '@project.version@'
  mvc:
    problemdetails:
      enabled: true

management:
  endpoints:
    web:
      exposure:
        include: '*'
  info:
    git:
      mode: full

server:
  port: 8888
  servlet:
    context-path: /${spring.application.name}
  error:
    whitelabel:
      enabled: false

Die bereitgestellte YAML-Konfiguration deckt mehrere Schlüsselbereiche Ihrer Spring Boot-Anwendung ab:

1. Anwendungseigenschaften:

Name: Definiert den Namen der Anwendung, hier auf Buchkatalog gesetzt.

Version: Verweist auf einen Platzhalter, der wahrscheinlich w?hrend des Erstellungsprozesses ausgefüllt wird, um die Version der Anwendung anzugeben.

1. MVC-Konfiguration:

problemdetails.enabled: Aktiviert detaillierte Problemberichte im Antworttext für Ausnahmen.

1. Verwaltungsendpunkte:

endpoints.web.exposure.include: '*':** Macht alle Aktor-Endpunkte für überwachungs- und Verwaltungszwecke verfügbar.

info.git.mode: full: Stellt detaillierte Git-Informationen im /info-Endpunkt bereit.

1. Serverkonfiguration:

Port: Legt den Port fest, auf dem der Server auf eingehende Anfragen lauscht (Standard 8080, hier auf 8888 eingestellt).

servlet.context-path: Definiert den Kontextpfad für die Anwendung und stellt sicher, dass Anforderungen korrekt weitergeleitet werden.

error.whitelabel.enabled: false: Deaktiviert die Standard-Whitelabel-Fehlerseite und erm?glicht so informativere Fehlermeldungen w?hrend der Entwicklung.

Banner.txt hinzufügen

1. Erstellen Sie die Datei ?banner.txt“

Erstellen Sie eine neue Datei mit dem Namen banner.txt im Verzeichnis src/main/resources Ihres Spring Boot-Projekts.

2. Fügen Sie Servicedetails zu banner.txt hinzu

Sie k?nnen dieser Datei beliebigen Text oder ASCII-Grafiken hinzufügen. Hier ist ein Beispiel:

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.boot.info.GitProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class OpenAPIConfig {

    @Bean
    public OpenAPI customOpenAPI(GitProperties gitProperties) {
        return new OpenAPI()
                .info(new Info()
                        .title("Book Catalog API")
                        .description("REST API for managing a book catalog. Application version: "+ gitProperties.get("build.version"))
                        .version("1.0.0")
                        .contact(new Contact()
                                .name("Book Catalog Team")
                                .email("support@bookcatalog.com")
                                .url("https://github.com/vlaship/book-catalog"))
                        .license(new License()
                                .name("MIT License")
                                .url("https://opensource.org/licenses/MIT"))
                );
    }
}

Dieser Ansatz verleiht Ihrem Anwendungsstart eine professionelle Note und liefert wertvolle Informationen auf einen Blick.

Dockerfile hinzufügen

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;

@Controller
public class OpenApiController {
    @GetMapping("/")
    public String index() {
        return "redirect:swagger-ui.html";
    }
}

Ebenenextraktion:Erstellung separater Ebenen für Abh?ngigkeiten, Verbesserung der Build-Effizienz und Reduzierung von Bildgr??enaktualisierungen.
Mehrstufiger Build: Verwendung eines mehrstufigen Build-Prozesses, um die Build-Umgebung von der Laufzeitumgebung zu trennen, was zu einem kleineren und effizienteren endgültigen Image führt.
Leichtes Basisbild:Verwenden eines minimalen Basisbildes wie azul/zulu-openjdk-alpine:21-jre-headless, um die Bildgr??e weiter zu reduzieren.

Dieser Ansatz führt zu schnelleren Builds, kleineren Bildgr??en und einer verbesserten Gesamtleistung für Ihre Spring Boot-Anwendung innerhalb eines Docker-Containers.

Das obige ist der detaillierte Inhalt vonSpringBoot-Webdienst – Teil der Erstkonfiguration. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!