Spring Boot Building RESTful Web Services https://www.tutorialspoint.com/spring_boot/spring_boot_building_restful_web_services.htm

Spring Boot provides a very good support to building RESTful Web Services for enterprise applications. This chapter will explain in detail about building RESTful web services using Spring Boot.

Note − For building a RESTful Web Services, we need to add the Spring Boot Starter Web dependency into the build configuration file.

If you are a Maven user, use the following code to add the below dependency in your pom.xml file −

<dependency>

   <groupId>org.springframework.boot</groupId>

   <artifactId>spring-boot-starter-web</artifactId>

</dependency>

If you are a Gradle user, use the following code to add the below dependency in your build.gradle file.

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

The code for complete build configuration file Maven build – pom.xml is given below −

<?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>

The code for complete build configuration file Gradle Build – build.gradle is given below −

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')

}

Before you proceed to build a RESTful web service, it is suggested that you have knowledge of the following annotations −

Rest Controller

The @RestController annotation is used to define the RESTful web services. It serves JSON, XML and custom response. Its syntax is shown below −

@RestController

public class ProductServiceController {

}

Request Mapping

The @RequestMapping annotation is used to define the Request URI to access the REST Endpoints. We can define Request method to consume and produce object. The default request method is GET.

@RequestMapping(value = "/products")

public ResponseEntity<Object> getProducts() { }

Request Body

The @RequestBody annotation is used to define the request body content type.

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

}

Path Variable

The @PathVariable annotation is used to define the custom or dynamic request URI. The Path variable in request URI is defined as curly braces {} as shown below −

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

}

Request Parameter

The @RequestParam annotation is used to read the request parameters from the Request URL. By default, it is a required parameter. We can also set default value for request parameters as shown here −

public ResponseEntity<Object> getProduct(

   @RequestParam(value = "name", required = false, defaultValue = "honey") String name) {

}

GET API

The default HTTP request method is GET. This method does not require any Request Body. You can send request parameters and path variables to define the custom or dynamic URL.

The sample code to define the HTTP GET request method is shown below. In this example, we used HashMap to store the Product. Note that we used a POJO class as the product to be stored.

Here, the request URI is /products and it will return the list of products from HashMap repository. The controller class file is given below that contains GET method 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

The HTTP POST request is used to create a resource. This method contains the Request Body. We can send request parameters and path variables to define the custom or dynamic URL.

The following example shows the sample code to define the HTTP POST request method. In this example, we used HashMap to store the Product, where the product is a POJO class.

Here, the request URI is /products, and it will return the String after storing the product into HashMap repository.

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

The HTTP PUT request is used to update the existing resource. This method contains a Request Body. We can send request parameters and path variables to define the custom or dynamic URL.

The example given below shows how to define the HTTP PUT request method. In this example, we used HashMap to update the existing Product, where the product is a POJO class.

Here the request URI is /products/{id} which will return the String after a the product into a HashMap repository. Note that we used the Path variable {id} which defines the products ID that needs to be updated.

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

The HTTP Delete request is used to delete the existing resource. This method does not contain any Request Body. We can send request parameters and path variables to define the custom or dynamic URL.

The example given below shows how to define the HTTP DELETE request method. In this example, we used HashMap to remove the existing product, which is a POJO class.

The request URI is /products/{id} and it will return the String after deleting the product from HashMap repository. We used the Path variable {id} which defines the products ID that needs to be deleted.

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);

   }

}

This section gives you the complete set of source code. Observe the following codes for their respective functionalities −

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);

   }

}

You can create an executable JAR file, and run the spring boot application by using the below Maven or Gradle commands as shown −

For Maven, use the command shown below −

mvn clean install

After “BUILD SUCCESS”, you can find the JAR file under the target directory.

For Gradle, use the command shown below −

gradle clean build

After “BUILD SUCCESSFUL”, you can find the JAR file under the build/libs directory.

You can run the JAR file by using the command shown below −

java –jar <JARFILE>

This will start the application on the Tomcat port 8080 as shown below −

POST

D:\worksp\springtest\src\main\java\com\neo\controller\HelloController.java

@RequestMapping(value = "/getES653ByPost", method = RequestMethod.POST)
public ResponseEntity getES653(@RequestBody TitleKeyword titleKeyword) throws IOException {
    String title = titleKeyword.getTitle();
    String keyword = titleKeyword.getKeyword();
    String keywords = titleKeyword.getKeywords();
    String res = title + keyword + keywords;
    System.out.println(res);
    JSONObject jsonObject = JSONObject.parseObject("{\"totalPv\":\"" + res + "\"}");
    return new ResponseEntity<JSONObject>(jsonObject, HttpStatus.OK);
}

D:\worksp\springtest\src\main\java\com\neo\dataAccessObj\TitleKeyword.java

package com.neo.dataAccessObj;

public class TitleKeyword {

    private String title;
    private String keyword;
    private String keywords;

    public String getTitle() {
        return title;
    }

    public String getKeyword() {
        return keyword;
    }

    public String getKeywords() {
        return keywords;
    }
}

post json格式字符串
application/json

												


											
Spring Boot - Building RESTful Web Services的更多相关文章
	

    
								
  1. Spring 3 来创建 RESTful Web Services
		
    Spring 3 创建 RESTful Web Services 在 Java™ 中,您可以使用以下几种方法来创建 RESTful Web Service:使用 JSR 311(311)及其参考实现  ...
    
		
    2. 
						
  2. RESTful Web Services: A Tutorial--reference
		
    As REST has become the default for most Web and mobile apps, it's imperative to have the basics at y ...
    
		
    3. 
						
  3. 使用 Spring 3 来创建 RESTful Web Services
		
    来源于:https://www.ibm.com/developerworks/cn/web/wa-spring3webserv/ 在 Java™ 中,您可以使用以下几种方法来创建 RESTful We ...
    
		
    4. 
						
  4. 使用 Spring 3 来创建 RESTful Web Services(转)
		
    使用 Spring 3 来创建 RESTful Web Services 在 Java™ 中,您可以使用以下几种方法来创建 RESTful Web Service:使用 JSR 311(311)及其参 ...
    
		
    5. 
						
  5. 基于Spring设计并实现RESTful Web Services(转)
		
    基于Spring设计并实现RESTful Web Services 在本教程中,你将会使用Spring来创建一个具有生产力的RESTful网络服务. 为什么用RESTful网络服务? 从和Amazon ...
    
		
    6. 
						
  6. CRUD using Spring MVC 4.0 RESTful Web Services and AngularJS
		
    国内私募机构九鼎控股打造APP,来就送 20元现金领取地址:http://jdb.jiudingcapital.com/phone.html内部邀请码:C8E245J (不写邀请码,没有现金送)国内私 ...
    
		
    7. 
						
  7. jboss7 Java API for RESTful Web Services (JAX-RS) 官方文档
		
    原文:https://docs.jboss.org/author/display/AS7/Java+API+for+RESTful+Web+Services+(JAX-RS) Content Tuto ...
    
		
    8. 
						
  8. 就是这么简单！使用Rest-assured 测试Restful Web Services
		
    使用 Rest-assured 测试 Restful Web Services 转载注明出处: http://www.cnblogs.com/wade-xu/p/4298819.html 这里向大家介 ...
    
		
    9. 
						
  9. Apache CXF实现Web Service（4）——Tomcat容器和Spring实现JAX-RS(RESTful) web service
		
    准备 我们仍然使用 Apache CXF实现Web Service(2)——不借助重量级Web容器和Spring实现一个纯的JAX-RS(RESTful) web service 中的代码作为基础,并 ...
    
		
    10. 
		

	


随机推荐
	

    
									
  1. linux -- Ubuntu图形界面终端实现注销、关机、重启
			
    linux命令行下的开关机分别为: 注销:logout 关机:shutdown -h now (参数不同,会有不同的关机模式) 重启:shutdown -r now 或 reboot 这些命令都是在l ...
    
			
    2. 
						
  2. 【Java面试题】14  super.getClass()方法调用
			
    下面程序的输出结果是多少? import java.util.Date; public class Test extends Date{ public static void main(String[ ...
    
			
    3. 
						
  3. Hibernate学习(2)：添加demo
			
    
			
    4. 
						
  4. Servlet+Ajax实现搜索智能提示
			
    一般在百度搜索框输入关键词时,会弹出一些相关信息提示,方便点选: 页面(search.jsp): <input type="text" name="keyWords ...
    
			
    5. 
						
  5. 关于Bundle
			
    1. 黄色的文件夹,打包的时候,不会建立目录,主要保存程序文件 - 素材不允许重名 2. 蓝色的文件夹,打包的时候,会建立目录,可以分目录的存储素材文件 - 素材可以重名 - 游戏的场景,backgr ...
    
			
    6. 
						
  6. Unity+高通Vuforia SDK——AR
			
    一.AR概念: 增强现实(Augmented Reality,简称AR),是在虚拟现实的基础上发展起来的新技术,也被称之为混合现实.是通过计算机系统提供的信息增加用户对现实世界感知的技术,将虚拟的信息 ...
    
			
    7. 
						
  7. MathType编辑半直积符号的步骤
			
    在数学中,特别是叫做群论的抽象代数领域中,半直积(semidirect product)是从其中一个是正规子群的两个子群形成一个群的特定方法.半直积是直积的推广.半直积是作为集合的笛卡尔积,但带有特定 ...
    
			
    8. 
						
  8. 查看当前mysql数据库实例中,支持的字符集有哪些,或者是否支持某个特定字符集
			
    需求描述: 查看当前mysql实例中支持哪些字符集,过滤特定的字符集 操作过程: 1.通过show character set来进行查看 mysql> show character set; + ...
    
			
    9. 
						
  9. python2.0 s12 day8 _ socketserver学习
			
    Socket 概念 一个socket就是一个点对点的链接.当今,大多数的通信都是基于Internet Protocl,因此大多数的网络Socket都是Internet Protocl(互联网)的通信( ...
    
			
    10. 
						
  10. 计算时间：一个C++运算符重载示例
			
    Time类是一个用于计算时间的类,其原型如下:程序清单11.1 mytime0.h // mytime0.h -- Time class before operator overloading #if ...
    
			
    11.