recherche
MaisonJavajavaDidacticielService Web SpringBoot - Configuration initiale de la pièce

SpringBoot Web Service - Part  Initial Configuration

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!

Déclaration
Le contenu de cet article est volontairement contribué par les internautes et les droits d'auteur appartiennent à l'auteur original. Ce site n'assume aucune responsabilité légale correspondante. Si vous trouvez un contenu suspecté de plagiat ou de contrefaçon, veuillez contacter admin@php.cn
Comment le sous-système de chargeur de classe du JVM contribue-t-il à l'indépendance de la plate-forme?Comment le sous-système de chargeur de classe du JVM contribue-t-il à l'indépendance de la plate-forme?Apr 23, 2025 am 12:14 AM

Le chargeur de classe garantit la cohérence et la compatibilité des programmes Java sur différentes plates-formes via le format de fichier de classe unifié, le chargement dynamique, le modèle de délégation parent et les bytecode indépendants de la plate-forme et réalisent l'indépendance de la plate-forme.

Le compilateur Java produit-il un code spécifique à la plate-forme? Expliquer.Le compilateur Java produit-il un code spécifique à la plate-forme? Expliquer.Apr 23, 2025 am 12:09 AM

Le code généré par le compilateur Java est indépendant de la plate-forme, mais le code finalement exécuté est spécifique à la plate-forme. 1. Le code source Java est compilé en bytecode indépendant de la plate-forme. 2. Le JVM convertit le bytecode en code machine pour une plate-forme spécifique, garantissant un fonctionnement multiplateforme mais les performances peuvent être différentes.

Comment le JVM gère-t-il le multithreading sur différents systèmes d'exploitation?Comment le JVM gère-t-il le multithreading sur différents systèmes d'exploitation?Apr 23, 2025 am 12:07 AM

Le multithreading est important dans la programmation moderne car elle peut améliorer la réactivité du programme et l'utilisation des ressources et gérer des tâches simultanées complexes. JVM assure la cohérence et l'efficacité des multitheads sur différents systèmes d'exploitation grâce à la cartographie des filetages, au mécanisme de planification et au mécanisme de verrouillage de synchronisation.

Que signifie «l'indépendance de la plate-forme» dans le contexte de Java?Que signifie «l'indépendance de la plate-forme» dans le contexte de Java?Apr 23, 2025 am 12:05 AM

L'indépendance de la plate-forme de Java signifie que le code écrit peut fonctionner sur n'importe quelle plate-forme avec JVM installé sans modification. 1) Le code source Java est compilé en bytecode, 2) ByteCode est interprété et exécuté par le JVM, 3) le JVM fournit des fonctions de gestion de la mémoire et de collecte des ordures pour s'assurer que le programme s'exécute sur différents systèmes d'exploitation.

Les applications Java peuvent-elles encore rencontrer des bogues ou des problèmes spécifiques à la plate-forme?Les applications Java peuvent-elles encore rencontrer des bogues ou des problèmes spécifiques à la plate-forme?Apr 23, 2025 am 12:03 AM

JavaApplicationsCanindeenCounterPlatform-spécificiSUesSuSesSetheTethejvm'sabstraction.reasonsinclude: 1) nativecode et libraires, 2) OperatingSystemdifferences, 3) jvmimplementationvariations, et4) condason

Comment le cloud computing a-t-il un impact sur l'importance de l'indépendance de la plate-forme de Java?Comment le cloud computing a-t-il un impact sur l'importance de l'indépendance de la plate-forme de Java?Apr 22, 2025 pm 07:05 PM

Le cloud computing améliore considérablement l'indépendance de la plate-forme de Java. 1) Le code Java est compilé en bytecode et exécuté par le JVM sur différents systèmes d'exploitation pour assurer le fonctionnement multiplateforme. 2) Utilisez Docker et Kubernetes pour déployer des applications Java pour améliorer la portabilité et l'évolutivité.

Quel rôle la plate-forme de Java a-t-elle joué dans son adoption généralisée?Quel rôle la plate-forme de Java a-t-elle joué dans son adoption généralisée?Apr 22, 2025 pm 06:53 PM

Java'splatformIndependenceNallowsDeveloperstowRiteCodeoncerandUnitonanyDeviceoroswithajvm. ThisisachievedthroughPulingToBytecode, quithejvMinterpretsorcompimentsAtruntime.ThisfeureHassignifant Boosttedjava'sadoptionDuetocross-PlatformDoyment, SplateFor, SplateformDoyment, sadoptionDuetocross-PlatformDoyment, Sendjava'sadoptionDuetocross-PlatformDoyment, Sendjava'sadoptionDuetocross-PlatformDoyment, Sendjava'sadoptionDuetocross-PlatformDoyment, SADOPtiondUtocross-PlatformDoyment, SADOPtiondUetocross-PlatformDoyment.

Comment les technologies de contenerisation (comme Docker) affectent-elles l'importance de l'indépendance de la plate-forme de Java?Comment les technologies de contenerisation (comme Docker) affectent-elles l'importance de l'indépendance de la plate-forme de Java?Apr 22, 2025 pm 06:49 PM

Les technologies de conteneurisation telles que Docker améliorent plutôt que de remplacer l'indépendance de la plate-forme de Java. 1) Assurer la cohérence entre les environnements, 2) Gérer les dépendances, y compris des versions JVM spécifiques, 3) Simplifier le processus de déploiement pour rendre les applications Java plus adaptables et gérables.

See all articles

Outils d'IA chauds

Undresser.AI Undress

Undresser.AI Undress

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

AI Clothes Remover

AI Clothes Remover

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

Undress AI Tool

Undress AI Tool

Images de déshabillage gratuites

Clothoff.io

Clothoff.io

Dissolvant de vêtements AI

Video Face Swap

Video Face Swap

Échangez les visages dans n'importe quelle vidéo sans effort grâce à notre outil d'échange de visage AI entièrement gratuit !

Outils chauds

Version crackée d'EditPlus en chinois

Version crackée d'EditPlus en chinois

Petite taille, coloration syntaxique, ne prend pas en charge la fonction d'invite de code

ZendStudio 13.5.1 Mac

ZendStudio 13.5.1 Mac

Puissant environnement de développement intégré PHP

DVWA

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

MantisBT

MantisBT

Mantis est un outil Web de suivi des défauts facile à déployer, conçu pour faciliter le suivi des défauts des produits. Cela nécessite PHP, MySQL et un serveur Web. Découvrez nos services de démonstration et d'hébergement.

mPDF

mPDF

mPDF est une bibliothèque PHP qui peut générer des fichiers PDF à partir de HTML encodé en UTF-8. L'auteur original, Ian Back, a écrit mPDF pour générer des fichiers PDF « à la volée » depuis son site Web et gérer différentes langues. Il est plus lent et produit des fichiers plus volumineux lors de l'utilisation de polices Unicode que les scripts originaux comme HTML2FPDF, mais prend en charge les styles CSS, etc. et présente de nombreuses améliorations. Prend en charge presque toutes les langues, y compris RTL (arabe et hébreu) ​​et CJK (chinois, japonais et coréen). Prend en charge les éléments imbriqués au niveau du bloc (tels que P, DIV),