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 :
- 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.
- Configuration MVC :
problemdetails.enabled : active les rapports de problèmes détaillés dans le corps de la réponse pour les exceptions.
- 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.
- 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!

Cet article analyse les quatre premiers cadres JavaScript (React, Angular, Vue, Svelte) en 2025, en comparant leurs performances, leur évolutivité et leurs perspectives d'avenir. Alors que tous restent dominants en raison de fortes communautés et écosystèmes, leur populaire relatif

L'article examine la mise en œuvre de la mise en cache à plusieurs niveaux en Java à l'aide de la caféine et du cache de goyave pour améliorer les performances de l'application. Il couvre les avantages de configuration, d'intégration et de performance, ainsi que la gestion de la politique de configuration et d'expulsion le meilleur PRA

Node.js 20 améliore considérablement les performances via des améliorations du moteur V8, notamment la collecte des ordures et les E / S plus rapides. Les nouvelles fonctionnalités incluent une meilleure prise en charge de Webassembly et des outils de débogage raffinés, augmentant la productivité des développeurs et la vitesse d'application.

Le chargement de classe de Java implique le chargement, la liaison et l'initialisation des classes à l'aide d'un système hiérarchique avec Bootstrap, Extension et Application Classloaders. Le modèle de délégation parent garantit que les classes de base sont chargées en premier, affectant la classe de classe personnalisée LOA

Iceberg, un format de table ouverte pour les grands ensembles de données analytiques, améliore les performances et l'évolutivité du lac Data. Il aborde les limites du parquet / orc par le biais de la gestion interne des métadonnées, permettant une évolution efficace du schéma, un voyage dans le temps, un W simultanément

Cet article aborde la vulnérabilité CVE-2022-1471 dans SnakeyAml, un défaut critique permettant l'exécution du code distant. Il détaille comment la mise à niveau des applications de démarrage de printemps vers SnakeyAml 1.33 ou ultérieurement atténue ce risque, en soulignant cette mise à jour de dépendance

L'article discute de l'utilisation de JPA pour la cartographie relationnelle des objets avec des fonctionnalités avancées comme la mise en cache et le chargement paresseux. Il couvre la configuration, la cartographie des entités et les meilleures pratiques pour optimiser les performances tout en mettant en évidence les pièges potentiels. [159 caractères]

Cet article explore l'intégration de la programmation fonctionnelle dans Java à l'aide d'expressions Lambda, de flux API, de références de méthode et facultatif. Il met en évidence des avantages tels que l'amélioration de la lisibilité au code et de la maintenabilité grâce à la concision et à l'immuabilité


Outils d'IA chauds

Undresser.AI Undress
Application basée sur l'IA pour créer des photos de nu réalistes

AI Clothes Remover
Outil d'IA en ligne pour supprimer les vêtements des photos.

Undress AI Tool
Images de déshabillage gratuites

Clothoff.io
Dissolvant de vêtements AI

AI Hentai Generator
Générez AI Hentai gratuitement.

Article chaud

Outils chauds

DVWA
Damn Vulnerable Web App (DVWA) est une application Web PHP/MySQL très vulnérable. Ses principaux objectifs sont d'aider les professionnels de la sécurité à tester leurs compétences et leurs outils dans un environnement juridique, d'aider les développeurs Web à mieux comprendre le processus de sécurisation des applications Web et d'aider les enseignants/étudiants à enseigner/apprendre dans un environnement de classe. Application Web sécurité. L'objectif de DVWA est de mettre en pratique certaines des vulnérabilités Web les plus courantes via une interface simple et directe, avec différents degrés de difficulté. Veuillez noter que ce logiciel

Télécharger la version Mac de l'éditeur Atom
L'éditeur open source le plus populaire

Dreamweaver Mac
Outils de développement Web visuel

PhpStorm version Mac
Le dernier (2018.2.1) outil de développement intégré PHP professionnel

Listes Sec
SecLists est le compagnon ultime du testeur de sécurité. Il s'agit d'une collection de différents types de listes fréquemment utilisées lors des évaluations de sécurité, le tout en un seul endroit. SecLists contribue à rendre les tests de sécurité plus efficaces et productifs en fournissant facilement toutes les listes dont un testeur de sécurité pourrait avoir besoin. Les types de listes incluent les noms d'utilisateur, les mots de passe, les URL, les charges utiles floues, les modèles de données sensibles, les shells Web, etc. Le testeur peut simplement extraire ce référentiel sur une nouvelle machine de test et il aura accès à tous les types de listes dont il a besoin.
