Contenu du cours

Backend Spring Boot

1. Notions de Base du Développement Backend

Introduction au Backend Comment Fonctionne HTTP HTTP/HTTPS Code de Statut Formats de Données : JSON et XML

2. Notions de Base de Spring Boot

Introduction à Spring Structure du Projet Spring MVC IoC et DI Architecture à Trois Niveaux Tâche de Printemps

3. API RESTful

Qu'est-ce Que REST?Principes de Base de REST Écrire Votre Propre API REST Travailler avec DTO Gestion des Exceptions Swagger Tester l'API RESTful

4. Travailler avec des Bases de Données

Introduction aux Bases de Données Relationnelles Connexion à une Base de Données MySQL Migrations de Base de Données Travailler avec ORM : JPA et Hibernate Ajouter la Base de Données à Notre Application Transactions

5. Tester les Applications Backend

Fondamentaux des Tests des Applications Backend Tests Modulaires avec JUnit Mockito Défi : Test Unitaire Résumé du Cours

Swagger

Dans ce chapitre, nous allons tester l'application. Pour ce faire, nous allons utiliser Swagger, un outil pratique qui ne nécessite pas d'installation car il est intégré directement dans notre application en l'ajoutant comme une dépendance.

Vous n'avez pas besoin d'écrire manuellement ce que chacune de vos méthodes fait ou les réponses potentielles qu'elle peut retourner; Swagger génère automatiquement tout cela en fonction de votre code et offre une interface conviviale.

Avec Swagger UI, les utilisateurs peuvent voir visuellement comment interagir avec l'API et tester les requêtes directement dans le navigateur, simplifiant à la fois le développement et les tests.

Exemple Réel

Imaginez que vous avez une boutique en ligne qui fournit une API pour créer des commandes, ajouter des articles au panier, calculer les frais de livraison, et traiter les paiements. Les développeurs travaillant pour vos clients ou partenaires peuvent utiliser cette API pour intégrer leurs applications avec votre système.

Si l'API est bien documentée à l'aide de Swagger, ils comprendront facilement comment appeler les méthodes nécessaires, quels paramètres passer, et quelles réponses attendre — sans avoir besoin de lire le code source ou de demander des clarifications.

Intégration avec Spring Boot

Intégrer Swagger dans un projet Spring Boot est assez simple et nécessite seulement d'ajouter quelques dépendances et annotations.

La première étape consiste à ajouter les dépendances nécessaires à votre fichier pom.xml (si vous utilisez Maven).

Configurer Swagger

Vous pouvez créer une classe de configuration pour Swagger si vous avez besoin de définir des paramètres supplémentaires, par exemple :

SwaggerConfig


              1234567891011
            
@Configuration
public class SwaggerConfig {

    @Bean
    public GroupedOpenApi publicApi() {
        return GroupedOpenApi.builder()
                .group("spring")
                .pathsToMatch("/**")
                .build();
    }
}

Ce code configure Swagger pour une application Spring Boot en utilisant une classe de configuration annotée avec @Configuration, ce qui indique que cette classe sera utilisée pour configurer les composants de l'application. À l'intérieur, un bean est créé en utilisant l'annotation @Bean, permettant à Spring de gérer son cycle de vie.

Le bean retourne un objet GroupedOpenApi, qui configure un groupe d'API nommé spring via la méthode group(). Ensuite, la méthode pathsToMatch("/") spécifie que Swagger doit documenter tous les chemins d'API disponibles, et l'appel à build() finalise le processus de configuration en créant l'objet avec les paramètres spécifiés.

Après avoir intégré Swagger dans le projet, vous pouvez accéder à la documentation à l'adresse suivante :

Résumé

Swagger est un outil puissant pour documenter les API REST, rendant le développement, test et maintenance des API beaucoup plus faciles.

Son intégration avec Spring Boot simplifie encore plus l'utilisation, grâce à la génération automatique de documentation et à l'interface conviviale Swagger UI pour tester les API.

1. Quel est le but principal de `Swagger`?

2. Comment accédez-vous à l'`Swagger UI` après l'avoir intégré dans un projet `Spring Boot` ?

Tout était clair ?

Merci pour vos commentaires !

Section 3. Chapitre 6