Dans cet article, nous explorerons comment configurer OpenAPI dans votre application Spring Boot et ajouter une redirection pratique de l'URL racine vers l'interface utilisateur Swagger. Cette configuration améliorera la documentation de votre API et la rendra plus accessible aux développeurs.

Configuration du bean OpenAPI

Tout d'abord, créons une classe de configuration pour personnaliser notre documentation OpenAPI?:

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"))
                );
    }
}

Cette configuration crée un bean OpenAPI personnalisé avec des informations de base sur votre API. Vous pouvez personnaliser davantage cela en ajoutant plus de détails, tels que des informations de contact, une licence ou une documentation externe.
Nous pouvons utiliser GitProperties pour fournir plus de détails.

Contr?leur de redirection d'URL racine

Ensuite, créons un contr?leur pour rediriger les utilisateurs de l'URL racine vers l'interface utilisateur Swagger?:

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";
    }
}

Ce contr?leur simple utilise un @GetMapping pour l'URL racine ("/") et redirige vers la page HTML de l'interface utilisateur Swagger.

Mise à jour du fichier application.yaml

Ce fichier de configuration, souvent nommé application.yml, joue un r?le crucial dans la définition de divers aspects du comportement de votre application.

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

La configuration YAML fournie couvre plusieurs domaines clés de votre application Spring Boot?:

1. Propriétés de l'application?:

name?: définit le nom de l'application, ici défini sur book-catalog.

version?: fait référence à un espace réservé, probablement renseigné pendant le processus de construction, pour spécifier la version de l'application.

1. Configuration MVC?:

problemdetails.enabled?: active les rapports de problèmes détaillés dans le corps de la réponse pour les exceptions.

1. Points de terminaison de gestion?:

endpoints.web.exposure.include?: '*'?:** Expose tous les points de terminaison de l'actionneur à des fins de surveillance et de gestion.

info.git.mode?: full?: fournit des informations Git détaillées dans le point de terminaison /info.

1. Configuration du serveur?:

port?: définit le port sur lequel le serveur écoute les requêtes entrantes (8080 par défaut, ici défini sur 8888).

servlet.context-path?: définit le chemin contextuel de l'application, garantissant que les requêtes sont correctement acheminées.

error.whitelabel.enabled?: false?: désactive la page d'erreur en marque blanche par défaut, permettant des messages d'erreur plus informatifs pendant le développement.

Ajout de bannière.txt

1. Créer un fichier bannière.txt

Créez un nouveau fichier nommé Banner.txt dans le répertoire src/main/resources de votre projet Spring Boot.

2. Ajoutez les détails du service à Banner.txt

Vous pouvez ajouter n’importe quel texte ou art ASCII à ce fichier. Voici un exemple?:

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"))
                );
    }
}

Cette approche ajoute une touche professionnelle au démarrage de votre application et fournit des informations précieuses en un coup d'?il.

Ajout d'un fichier Docker

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";
    }
}

Extraction de couches?: Création de couches distinctes pour les dépendances, amélioration de l'efficacité de la construction et réduction des mises à jour de la taille des images.
Construction en plusieurs étapes?: Utilisation d'un processus de construction en plusieurs étapes pour séparer l'environnement de construction de l'environnement d'exécution, ce qui permet d'obtenir une image finale plus petite et plus efficace.
Image de base légère?: Utilisation d'une image de base minimale comme azul/zulu-openjdk-alpine:21-jre-headless pour réduire davantage la taille de l'image.

Cette approche conduit à des constructions plus rapides, à des tailles d'image plus petites et à des performances globales améliorées pour votre application Spring Boot dans un conteneur Docker.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!