Spring Boot fournit un très bon prise en charge de la création de services web RESTful pour les applications D’entreprise. Ce chapitre expliquera en détail la création de services web RESTful à l’aide de Spring Boot.
Remarque-pour créer un service Web RESTful, nous devons ajouter la dépendance Web Spring Boot Starter dans le fichier de configuration de construction.,
Si vous êtes un utilisateur Maven, utilisez le code suivant pour ajouter la dépendance ci-dessous dans votre pom.xml file-
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency>
Si vous êtes un utilisateur Gradle, utilisez le code suivant pour ajouter la dépendance ci-dessous dans votre build.fichier gradle.
compile('org.springframework.boot:spring-boot-starter-web')
le code pour le fichier de configuration de construction complète Maven build – pom.xml est donné ci – dessous –
le code pour le fichier de configuration de construction complète Gradle Build-build.,gradle est donné ci −dessous –
avant de créer un service Web RESTful, il est suggéré que vous connaissiez les annotations suivantes –
Rest Controller
L’annotation @RestController est utilisée pour définir les services web RESTful. Il sert JSON, XML et réponse personnalisée. Sa syntaxe est montrée ci-dessous –
@RestControllerpublic class ProductServiceController { }
Request Mapping
L’annotation @RequestMapping est utilisée pour définir l’URI de la demande pour accéder aux points de terminaison REST. Nous pouvons définir une méthode de requête pour consommer et produire un objet. La méthode de demande par défaut est GET.,
@RequestMapping(value = "/products")public ResponseEntity<Object> getProducts() { }
corps de la requête
L’annotation @RequestBody est utilisée pour définir le type de contenu du corps de la requête.
public ResponseEntity<Object> createProduct(@RequestBody Product product) {}
Variable de chemin
L’annotation @PathVariable est utilisée pour définir l’URI de requête personnalisée ou dynamique. La variable Path dans l’URI de la demande est définie comme des accolades {} comme indiqué ci-dessous –
public ResponseEntity<Object> updateProduct(@PathVariable("id") String id) {}
paramètre de demande
L’annotation @RequestParam est utilisée pour lire les paramètres de la demande à partir de l’URL de la demande. Par défaut, ce paramètre est obligatoire., Nous pouvons également définir la valeur par défaut pour les paramètres de requête comme indiqué ici-
public ResponseEntity<Object> getProduct( @RequestParam(value = "name", required = false, defaultValue = "honey") String name) {}
GET API
la méthode de requête HTTP par défaut est GET. Cette méthode ne nécessite aucun corps de requête. Vous pouvez envoyer des paramètres de demande et des variables de chemin pour définir l’URL personnalisée ou dynamique.
l’exemple de code pour définir la méthode de requête HTTP GET est illustré ci-dessous. Dans cet exemple, nous avons utilisé HashMap pour stocker le produit. Notez que nous avons utilisé une classe POJO comme produit à stocker.
ici, l’URI de la requête est / products et il renverra la liste des produits du référentiel HashMap., Le fichier de classe controller est donné ci-dessous qui contient le point de terminaison REST de la méthode GET.
API POST
la requête HTTP POST est utilisée pour créer une ressource. Cette méthode contient le corps de la requête. Nous pouvons envoyer des paramètres de demande et des variables de chemin pour définir l’URL personnalisée ou dynamique.
l’exemple suivant montre l’exemple de code pour définir la méthode de requête HTTP POST. Dans cet exemple, nous avons utilisé HashMap pour stocker le produit, où le produit est une classe POJO.
ici, l’URI de la requête est / products, et il retournera la chaîne après avoir stocké le produit dans le référentiel HashMap.,
PUT API
la requête HTTP PUT est utilisée pour mettre à jour la ressource existante. Cette méthode contient un corps de requête. Nous pouvons envoyer des paramètres de demande et des variables de chemin pour définir l’URL personnalisée ou dynamique.
l’exemple ci-dessous montre comment définir la méthode de requête HTTP PUT. Dans cet exemple, nous avons utilisé HashMap pour mettre à jour le produit existant, où le produit est une classe POJO.
ici, l’URI de la requête est/products / {id} qui renverra la chaîne après un produit dans un référentiel HashMap., Notez que nous avons utilisé la variable Path {id} qui définit l’ID des produits à mettre à jour.
DELETE API
la requête HTTP Delete est utilisée pour supprimer la ressource existante. Cette méthode ne contient aucun corps de requête. Nous pouvons envoyer des paramètres de demande et des variables de chemin pour définir l’URL personnalisée ou dynamique.
l’exemple ci-dessous montre comment définir la méthode de requête de suppression HTTP. Dans cet exemple, nous avons utilisé HashMap pour supprimer le produit existant, qui est une classe POJO.,
l’URI de la requête est /products/{id} et il retournera la chaîne après avoir supprimé le produit du référentiel HashMap. Nous avons utilisé la variable Path {id} qui définit l’ID des produits à supprimer.
Cette section vous donne l’ensemble du code source. Observez les codes suivants pour leurs fonctionnalités respectives −
la classe D’application principale Spring Boot – DemoApplication.java
Le produit de classe POJO.java
la classe Rest Controller – ProductServiceController.,java
Vous pouvez créer un fichier JAR exécutable et exécuter l’application spring boot en utilisant les commandes Maven ou Gradle ci −dessous comme indiqué −
pour Maven, utilisez la commande ci-dessous –
mvn clean install
Après « BUILD SUCCESS”, vous pouvez trouver le fichier JAR sous le répertoire cible.
pour Gradle, utilisez la commande ci −dessous –
gradle clean build
Après « BUILD SUCCESSFUL”, vous pouvez trouver le fichier JAR dans le répertoire build/libs.,
Vous pouvez exécuter le fichier JAR à l’aide de la commande ci −dessous
java –jar <JARFILE>
Cela va démarrer l’application sur Tomcat port 8080 comme indiqué ci-dessous −
Maintenant cliquez sur l’URL ci-dessous dans le FACTEUR de l’application et de voir le résultat.,
GET API URL is: http://localhost:8080/products
POST API URL is: http://localhost:8080/products
PUT API URL is: http://localhost:8080/products/3
DELETE API URL is: http://localhost:8080/products/3
