<div id="readability-page-1" class="page"><div id="main" role="main">
 <article>
 <div>
 
 
 

<h2 id="environment-and-prerequisite">Environment and Prerequisite</h2>

<ul>
 <li>Java</li>
 <li>IntelliJ</li>
</ul>



<h2 id="setting">Setting</h2>

<h3 id="prepare-spring-test">Prepare Spring Test</h3>

<ul>
 <li>Make project like below in <a href="https://start.spring.io/">https://start.spring.io/</a></li>
</ul>

<img src="https://twpower.github.io/images/20240128_338/spring-init.png">


<h3 id="setting-rest-assured-in-gradle">Setting Rest Assured in Gradle</h3>

<div><pre><code>plugins {
	id 'java'
	id 'org.springframework.boot' version '3.2.2'
	id 'io.spring.dependency-management' version '1.1.4'
}

group = 'me.twpower'
version = '0.0.1-SNAPSHOT'

java {
	sourceCompatibility = '21'
}

configurations {
	compileOnly {
		extendsFrom annotationProcessor
	}
}

repositories {
	mavenCentral()
}

dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-data-jdbc'
	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
	implementation 'org.springframework.boot:spring-boot-starter-jdbc'
	implementation 'org.springframework.boot:spring-boot-starter-security'
	implementation 'org.springframework.boot:spring-boot-starter-web'
	compileOnly 'org.projectlombok:lombok'
	runtimeOnly 'com.h2database:h2'
	annotationProcessor 'org.projectlombok:lombok'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
	testImplementation 'org.springframework.security:spring-security-test'
	testImplementation 'io.rest-assured:rest-assured:5.4.0' // Added
}

tasks.named('test') {
	useJUnitPlatform()
}

</code></pre></div>



<h2 id="code">Code</h2>

<ul>
 <li><code>given()</code>: Set up necessary components such as headers or parameters before making a request</li>
 <li><code>when()</code>: Input URI or method for the actual request</li>
 <li><code>then()</code>: Define verification steps</li>
 <li>There many methods to test beyond above method.</li>
</ul>

<div><pre><code>package me.twpower.restassuredpractice;

import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import static io.restassured.RestAssured.*;
import static org.hamcrest.Matchers.equalTo;

@SpringBootTest
public class RestAssuredPracticeTest {
 @Test
 void restAssuredPracticeTest() {
 // JSON Example
 // Call http://echo.jsontest.com/key1/value1/key2/value2/key3/3
 /*
 {
 "key1": "value1",
 "key2": "value2",
 "key3": "3"
 }
 */

 // given(): Start building the request part of the test io.restassured.specification.
 // when(): Start building the DSL expression by sending a request without any parameters or headers etc.
 // then(): Returns a validatable response that's lets you validate the response.

 given().
 header("Content-Type", "application/json").
 baseUri("http://echo.jsontest.com/").
 when().
 get("/key1/value1/key2/value2/key3/3").
 then().
 body("key1", equalTo("value1"));
 }
}

</code></pre></div>



<h2 id="result">Result</h2>

<ul>
 <li>Success</li>
</ul>

<img src="https://twpower.github.io/images/20240128_338/test-pass.png">


<ul>
 <li>Fail</li>
</ul>

<div><pre><code>java.lang.AssertionError: 1 expectation failed.
JSON path key1 doesn't match.
Expected: value2
 Actual: value1
</code></pre></div>



<h2 id="reference">Reference</h2>

<ul>
 <li><a href="https://www.javadoc.io/doc/io.rest-assured/rest-assured/latest/index.html">https://www.javadoc.io/doc/io.rest-assured/rest-assured/latest/index.html</a></li>
 <li><a href="https://github.com/rest-assured/rest-assured/wiki/GettingStarted">https://github.com/rest-assured/rest-assured/wiki/GettingStarted</a></li>
 <li><a href="https://github.com/TWpower/restassuredpractice">https://github.com/TWpower/restassuredpractice</a></li>
</ul>

 
 
 
 </div>
 
 
 

 </article>
</div></div>

TWpower’s Tech Blog

Environment and Prerequisite
Java
IntelliJ
Setting
Prepare Spring Test
Make project like below in https://start.spring.io/
Setting Rest Assured in Gradle
plugins {
	id 'java'
	id 'org.springframework.boot' version '3.2.2'
	id 'io.spring.dependency-management' version '1.1.4'
}
group = 'me.twpower'
version = '0.0.1-SNAPSHOT'
java {
	sourceCompatibility = '21'
}
configurations {
	compileOnly {
		extendsFrom annotationProcessor
	}
}
repositories {
	mavenCentral()
}
dependencies {
	implementation 'org.springframework.boot:spring-boot-starter-data-jdbc'
	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
	implementation 'org.springframework.boot:spring-boot-starter-jdbc'
	implementation 'org.springframework.boot:spring-boot-starter-security'
	implementation 'org.springframework.boot:spring-boot-starter-web'
	compileOnly 'org.projectlombok:lombok'
	runtimeOnly 'com.h2database:h2'
	annotationProcessor 'org.projectlombok:lombok'
	testImplementation 'org.springframework.boot:spring-boot-starter-test'
	testImplementation 'org.springframework.security:spring-security-test'
	testImplementation 'io.rest-assured:rest-assured:5.4.0' // Added
}
tasks.named('test') {
	useJUnitPlatform()
}
Code
given(): Set up necessary components such as headers or parameters before making a request
when(): Input URI or method for the actual request
then(): Define verification steps
There many methods to test beyond above method.
package me.twpower.restassuredpractice;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import static io.restassured.RestAssured.*;
import static org.hamcrest.Matchers.equalTo;
@SpringBootTest
public class RestAssuredPracticeTest {
    @Test
    void restAssuredPracticeTest() {
        // JSON Example
        // Call http://echo.jsontest.com/key1/value1/key2/value2/key3/3
        /*
        {
            "key1": "value1",
                "key2": "value2",
                "key3": "3"
        }
        */
        // given(): Start building the request part of the test io.restassured.specification.
        // when(): Start building the DSL expression by sending a request without any parameters or headers etc.
        // then(): Returns a validatable response that's lets you validate the response.
        given().
                header("Content-Type", "application/json").
                baseUri("http://echo.jsontest.com/").
        when().
                get("/key1/value1/key2/value2/key3/3").
        then().
                body("key1", equalTo("value1"));
    }
}
Result
Success
  
Fail
java.lang.AssertionError: 1 expectation failed.
JSON path key1 doesn't match.
Expected: value2
  Actual: value1
Reference
https://www.javadoc.io/doc/io.rest-assured/rest-assured/latest/index.html
https://github.com/rest-assured/rest-assured/wiki/GettingStarted
https://github.com/TWpower/restassuredpractice

[Java] Rest Assured Setting and Example for API Test

댓글