Spring Boot REST API

Testing REST API

In Pom.xml add below:

            <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.springframework.restdocs</groupId>
    <artifactId>spring-restdocs-mockmvc</artifactId>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>com.jayway.restassured</groupId>
    <artifactId>rest-assured</artifactId>
    <version>2.8.0</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.codehaus.groovy</groupId>
    <artifactId>groovy-all</artifactId>
    <version>2.4.5</version>
</dependency>

Complete Pom.xml as below given:

            <?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>
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.0.BUILD-SNAPSHOT</version>
    <relativePath /> <!-- lookup parent from repository -->
</parent>
    <groupId>com.javabykiran</groupId>
    <artifactId>JBK_Spring_Boot_REST_API_Ex</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>JBK_Spring_Boot_REST_API_Ex</name>
    <description>Jbk project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
	<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-rest</artifactId>
	</dependency>
	<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jersey</artifactId>
	</dependency>
        <dependency>
            <groupId>org.springframework.data</groupId>
            <artifactId>spring-data-rest-hal-browser</artifactId>
	</dependency>
	<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
	</dependency>
        <dependency>
            <groupId>org.springframework.restdocs</groupId>
            <artifactId>spring-restdocs-mockmvc</artifactId>
            <scope>test</scope>
	</dependency>
	<dependency>
            <groupId>com.jayway.restassured</groupId>
            <artifactId>rest-assured</artifactId>
            <version>2.8.0</version>
            <scope>test</scope>
	</dependency>
	<dependency>
            <groupId>org.codehaus.groovy</groupId>
            <artifactId>groovy-all</artifactId>
            <version>2.4.5</version>
	</dependency>
    </dependencies>
    <build>
	<plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
	</plugins>
    </build>
    <repositories>
	<repository>
            <id>spring-snapshots</id>
            <name>Spring Snapshots</name>
            <url>https://repo.spring.io/snapshot</url>
            <snapshots>
		<enabled>true</enabled>
            </snapshots>
	</repository>
	<repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
	</repository>
    </repositories>
    <pluginRepositories>
	<pluginRepository>
            <id>spring-snapshots</id>
            <name>Spring Snapshots</name>
            <url>https://repo.spring.io/snapshot</url>
            <snapshots>
		<enabled>true</enabled>
            </snapshots>
	</pluginRepository>
	<pluginRepository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
	</pluginRepository>
    </pluginRepositories>
</project>

Add testing code as below. Test/java/com/javabykiran/springboot folder

            package com.javabykiran.springboot;
import static com.jayway.restassured.RestAssured.*;
import static org.hamcrest.Matchers.*;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.TestPropertySource;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import com.javabykiran.Transaction;
import com.jayway.restassured.RestAssured;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = JbkSpringBootRestApiExApplication.class)
@TestPropertySource(value = { "classpath:application.properties" })

@SpringBootTest(webEnvironment = WebEnvironment.DEFINED_PORT)
public class JbkSpringBootRestApiExApplicationTests {
    @Value("${server.port}")
    int port;
    @Test
    public void getDataTest() {
	Transaction trans = new Transaction("123", "kiran", "Flipkart");
	get("/transaction/get").then().assertThat().body(equalTo(trans));
    }
    @Before
    public void setBaseUri() {
	RestAssured.port = port;
	RestAssured.baseURI = "http://localhost"; // replace as appropriate
    }
}

Run this code as junit test.

Note that we have added some annotations here to run the tests in a web environment.

@RunWith(SpringJUnit4ClassRunner.class) supports loading of the Spring application context.

@ContextConfiguration defines class-level metadata that is used to determine how to load and configure a context for integration tests. [main class used for developing rest api]

@TestPropertySource is used to configure the values of properties files.

SpringBootTest tells Spring Boot to go and look for a main configuration class (one with @SpringBootApplication, for instance) and use that to start a Spring application context.