Spring Boot - Criando serviços da Web RESTful

Spring Boot fornece um suporte muito bom para a construção de RESTful Web Services para aplicativos corporativos. Este capítulo irá explicar em detalhes sobre a construção de serviços da Web RESTful usando Spring Boot.

Note - Para construir um RESTful Web Services, precisamos adicionar a dependência Spring Boot Starter Web ao arquivo de configuração de construção.

Se você for um usuário Maven, use o seguinte código para adicionar a dependência abaixo em seu pom.xml arquivo -

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>    
</dependency>

Se você for um usuário Gradle, use o código a seguir para adicionar a dependência abaixo em seu build.gradle Arquivo.

compile('org.springframework.boot:spring-boot-starter-web')

O código para o arquivo de configuração de compilação completo Maven build – pom.xml é dado abaixo -

<?xml version = "1.0" encoding = "UTF-8"?>
<project xmlns = "http://maven.apache.org/POM/4.0.0" 
   xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0 
   http://maven.apache.org/xsd/maven-4.0.0.xsd">
   
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.tutorialspoint</groupId>
   <artifactId>demo</artifactId>
   <version>0.0.1-SNAPSHOT</version>
   <packaging>jar</packaging>
   <name>demo</name>
   <description>Demo project for Spring Boot</description>
   
   <parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>1.5.8.RELEASE</version>
      <relativePath/> 
   </parent>
   
   <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
      <java.version>1.8</java.version>
   </properties>
   
   <dependencies>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-web</artifactId>
      </dependency>
      <dependency>
         <groupId>org.springframework.boot</groupId>
         <artifactId>spring-boot-starter-test</artifactId>
         <scope>test</scope>
      </dependency>
   </dependencies>
   
   <build>
      <plugins>
         <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
         </plugin>
      </plugins>
   </build>
   
</project>

O código para o arquivo de configuração de compilação completo Gradle Build – build.gradle é dado abaixo -

buildscript {
   ext {
      springBootVersion = '1.5.8.RELEASE'
   }
   repositories {
      mavenCentral()
   }
   dependencies {
      classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
   }
}

apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'

group = 'com.tutorialspoint'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8

repositories {
   mavenCentral()
}
dependencies {
   compile('org.springframework.boot:spring-boot-starter-web')
   testCompile('org.springframework.boot:spring-boot-starter-test')
}

Antes de prosseguir com a construção de um serviço da web RESTful, sugere-se que você tenha conhecimento das seguintes anotações -

Controlador de descanso

A anotação @RestController é usada para definir os serviços da web RESTful. Ele serve JSON, XML e resposta personalizada. Sua sintaxe é mostrada abaixo -

@RestController
public class ProductServiceController { 
}

Solicitar Mapeamento

A anotação @RequestMapping é usada para definir o URI de solicitação para acessar os terminais REST. Podemos definir o método Request para consumir e produzir objeto. O método de solicitação padrão é GET.

@RequestMapping(value = "/products")
public ResponseEntity<Object> getProducts() { }

Corpo de Solicitação

A anotação @RequestBody é usada para definir o tipo de conteúdo do corpo da solicitação.

public ResponseEntity<Object> createProduct(@RequestBody Product product) {
}

Variável de Caminho

A anotação @PathVariable é usada para definir o URI de solicitação personalizado ou dinâmico. A variável Path no URI de solicitação é definida como chaves {} conforme mostrado abaixo -

public ResponseEntity<Object> updateProduct(@PathVariable("id") String id) {
}

Parâmetro de solicitação

A anotação @RequestParam é usada para ler os parâmetros de solicitação da URL de solicitação. Por padrão, é um parâmetro obrigatório. Também podemos definir o valor padrão para os parâmetros de solicitação, conforme mostrado aqui -

public ResponseEntity<Object> getProduct(
   @RequestParam(value = "name", required = false, defaultValue = "honey") String name) {
}

API GET

O método de solicitação HTTP padrão é GET. Este método não requer nenhum corpo de solicitação. Você pode enviar parâmetros de solicitação e variáveis de caminho para definir o URL personalizado ou dinâmico.

O código de amostra para definir o método de solicitação HTTP GET é mostrado abaixo. Neste exemplo, usamos HashMap para armazenar o produto. Observe que usamos uma classe POJO como o produto a ser armazenado.

Aqui, o URI do pedido é /productse ele retornará a lista de produtos do repositório HashMap. O arquivo de classe do controlador é fornecido a seguir e contém o método GET REST Endpoint.

package com.tutorialspoint.demo.controller;

import java.util.HashMap;
import java.util.Map;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.tutorialspoint.demo.model.Product;

@RestController
public class ProductServiceController {
   private static Map<String, Product> productRepo = new HashMap<>();
   static {
      Product honey = new Product();
      honey.setId("1");
      honey.setName("Honey");
      productRepo.put(honey.getId(), honey);
      
      Product almond = new Product();
      almond.setId("2");
      almond.setName("Almond");
      productRepo.put(almond.getId(), almond);
   }
   @RequestMapping(value = "/products")
   public ResponseEntity<Object> getProduct() {
      return new ResponseEntity<>(productRepo.values(), HttpStatus.OK);
   }
}

POST API

A solicitação HTTP POST é usada para criar um recurso. Este método contém o corpo da solicitação. Podemos enviar parâmetros de solicitação e variáveis de caminho para definir o URL personalizado ou dinâmico.

O exemplo a seguir mostra o código de amostra para definir o método de solicitação HTTP POST. Neste exemplo, usamos HashMap para armazenar o Produto, onde o produto é uma classe POJO.

Aqui, o URI do pedido é /products, e ele retornará a String após armazenar o produto no repositório HashMap.

package com.tutorialspoint.demo.controller;

import java.util.HashMap;
import java.util.Map;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import com.tutorialspoint.demo.model.Product;

@RestController
public class ProductServiceController {
   private static Map<String, Product> productRepo = new HashMap<>();
   
   @RequestMapping(value = "/products", method = RequestMethod.POST)
   public ResponseEntity<Object> createProduct(@RequestBody Product product) {
      productRepo.put(product.getId(), product);
      return new ResponseEntity<>("Product is created successfully", HttpStatus.CREATED);
   }
}

PUT API

A solicitação HTTP PUT é usada para atualizar o recurso existente. Este método contém um corpo de solicitação. Podemos enviar parâmetros de solicitação e variáveis de caminho para definir o URL personalizado ou dinâmico.

O exemplo fornecido a seguir mostra como definir o método de solicitação HTTP PUT. Neste exemplo, usamos o HashMap para atualizar o Produto existente, onde o produto é uma classe POJO.

Aqui, o URI do pedido é /products/{id}que retornará a String após o produto em um repositório HashMap. Observe que usamos a variável Path{id} que define o ID do produto que precisa ser atualizado.

package com.tutorialspoint.demo.controller;

import java.util.HashMap;
import java.util.Map;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import com.tutorialspoint.demo.model.Product;

@RestController
public class ProductServiceController {
   private static Map<String, Product> productRepo = new HashMap<>();
   
   @RequestMapping(value = "/products/{id}", method = RequestMethod.PUT)
   public ResponseEntity<Object> updateProduct(@PathVariable("id") String id, @RequestBody Product product) { 
      productRepo.remove(id);
      product.setId(id);
      productRepo.put(id, product);
      return new ResponseEntity<>("Product is updated successsfully", HttpStatus.OK);
   }   
}

DELETE API

A solicitação HTTP Delete é usada para excluir o recurso existente. Este método não contém nenhum corpo de solicitação. Podemos enviar parâmetros de solicitação e variáveis de caminho para definir o URL personalizado ou dinâmico.

O exemplo fornecido a seguir mostra como definir o método de solicitação HTTP DELETE. Neste exemplo, usamos o HashMap para remover o produto existente, que é uma classe POJO.

O URI do pedido é /products/{id}e ele retornará a String após excluir o produto do repositório HashMap. Usamos a variável Path{id} que define o ID do produto que precisa ser excluído.

package com.tutorialspoint.demo.controller;

import java.util.HashMap;
import java.util.Map;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import com.tutorialspoint.demo.model.Product;

@RestController
public class ProductServiceController {
   private static Map<String, Product> productRepo = new HashMap<>();
   
   @RequestMapping(value = "/products/{id}", method = RequestMethod.DELETE)
   public ResponseEntity<Object> delete(@PathVariable("id") String id) { 
      productRepo.remove(id);
      return new ResponseEntity<>("Product is deleted successsfully", HttpStatus.OK);
   }
}

Esta seção fornece o conjunto completo de código-fonte. Observe os seguintes códigos para suas respectivas funcionalidades -

The Spring Boot main application class – DemoApplication.java

package com.tutorialspoint.demo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication {
   public static void main(String[] args) {
      SpringApplication.run(DemoApplication.class, args);
   }
}

The POJO class – Product.java

package com.tutorialspoint.demo.model;

public class Product {
   private String id;
   private String name;

   public String getId() {
      return id;
   }
   public void setId(String id) {
      this.id = id;
   }
   public String getName() {
      return name;
   }
   public void setName(String name) {
      this.name = name;
   }
}

The Rest Controller class – ProductServiceController.java

package com.tutorialspoint.demo.controller;

import java.util.HashMap;
import java.util.Map;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import com.tutorialspoint.demo.model.Product;

@RestController
public class ProductServiceController {
   private static Map<String, Product> productRepo = new HashMap<>();
   static {
      Product honey = new Product();
      honey.setId("1");
      honey.setName("Honey");
      productRepo.put(honey.getId(), honey);
      
      Product almond = new Product();
      almond.setId("2");
      almond.setName("Almond");
      productRepo.put(almond.getId(), almond);
   }
   
   @RequestMapping(value = "/products/{id}", method = RequestMethod.DELETE)
   public ResponseEntity<Object> delete(@PathVariable("id") String id) { 
      productRepo.remove(id);
      return new ResponseEntity<>("Product is deleted successsfully", HttpStatus.OK);
   }
   
   @RequestMapping(value = "/products/{id}", method = RequestMethod.PUT)
   public ResponseEntity<Object> updateProduct(@PathVariable("id") String id, @RequestBody Product product) { 
      productRepo.remove(id);
      product.setId(id);
      productRepo.put(id, product);
      return new ResponseEntity<>("Product is updated successsfully", HttpStatus.OK);
   }
   
   @RequestMapping(value = "/products", method = RequestMethod.POST)
   public ResponseEntity<Object> createProduct(@RequestBody Product product) {
      productRepo.put(product.getId(), product);
      return new ResponseEntity<>("Product is created successfully", HttpStatus.CREATED);
   }
   
   @RequestMapping(value = "/products")
   public ResponseEntity<Object> getProduct() {
      return new ResponseEntity<>(productRepo.values(), HttpStatus.OK);
   }
}

Você pode criar um arquivo JAR executável e executar o aplicativo Spring Boot usando os comandos Maven ou Gradle abaixo, conforme mostrado -

Para Maven, use o comando mostrado abaixo -