REST-Assured framework overview

In modern software development, REST services becomes most popular choice for implementing distributed and scalable web application. They are light and easy to maintain, which results in faster and more effective implementation and system integration.

obama-min


I recommend you also my other posts about REST-Assured and building microservice’s test automation frameworks:

With the increase popularity of RESTful services, there is a need for fast and lightweight tool for REST webservices testing automation. One of the most popular choice is Rest-Assured framework from Jayway. It introduces simplicity of testing web services from dynamic languages like groovy or ruby to java. In this post we will get our hands dirty and write automatic test in Rest-Assured framework.

In order to create complete implementation of automated tests in Rest-Assured framework, we need to write our code against some example API. We’ll use standalone Wiremock mock server, which we had created in previous article (full API documentation with setup tutorial can be found here) or you can just clone working project from my github. Endpoints specifications of API that we will test look as follows:

First method:

  • request:

Screen Shot 2015-08-05 at 21.27.28

  • response:

Screen Shot 2015-08-05 at 21.33.32

Second method:

  • request:

Screen Shot 2015-08-05 at 21.34.28

  • response:

Screen Shot 2015-08-05 at 21.35.02

Setting up

First thing which we have to do is of course to add Rest-Assured dependencies to our project. If you are using gradle, add this dependency to your TestCompile scope:

testCompile ‘com.jayway.restassured:rest-assured:2.4.1’

and the same for Maven users:

<dependency>
<groupId>com.jayway.restassured</groupId>
<artifactId>rest-assured</artifactId>
<version>2.4.1</version>
<scope>test</scope>
</dependency>

You can also add libaries to your classpath manualy. After refreshing or rebuilding our project we are able to use Rest-Assured. The last thing is to use static import in our test class:

import static com.jayway.restassured.RestAssured.*;

Writing tests

Rest-Assured is using given/when/then notation. In Given section we declare things like content type or request body. In When section we provide HTTP method and endpoint. In Then section we declare response verification. The method hitting our first API method looks as follows:

Every section in method body corresponds to our mock declaration. We are making GET request on /user/{userID} endpoint, and then we check if response contains id, login and www elements, and if the response status is 200. After declaring getUserData method, we can write test method (RestService is a class that contains getUserData method):

Second endpoint in our mock provide POST method. Request body should be declared in Given section, and the rest looks similarly:

…and the test methods that calls method above:

Extras

Although that main test flow in Rest-Assured is pretty straightforward, framework equips us with many useful features. One of my favourite is log method. Below is an example of using built-in logger in rest-assured method. No magic here, just call log().all() method:

Another important feature is HTTPS Validation. If you have some HTTPS issues, and your test flow doesn’t check any security cases, you can simply call:

RestAssured.useRelaxedHTTPSValidation();

One of the most obvious use case would be extracting values. With Rest-Assured 2.0 it couldn’t be easier. Here’s an example of extracting login value from getUserData() method response:

Those are just few examples. Rest-Assured exposes rich API, that makes your test development easy and effective.


Continue reading

If you want to continue reading and expand your knowledge in area of  REST and microservices, I recommend you these books:

  • Building Microservices – one of the most important books for me, everything you want to know about microservices is here
  • RESTful Web APIs – another great book about REST architecture. Lots of practical knowledge about designing and consuming RESTful APIs

Summary

When it comes to test RESTful architecture in Java, Rest-Assured should be your first-choice framework. Test development is easy and efficient. You can learn more about framework in official documentation or go through excellent examples in official jayway github. Complete project from this post is avabile for download from here.

  • Sergii Kaliberda

    Awesome article. Thanks!

  • Pingback: REST-Assured: going deeper | TEST DETECTIVE()

  • Pingback: 2015 Retrospective and Planning | TEST DETECTIVE()

  • Pingback: Building microservices testing framework | TEST DETECTIVE()

  • Anton Guba

    Great!

  • Swapnil Nirhali

    Nice informative article.

  • Pingback: RESTful services automated testing – SelvaSantosh()

  • Mukund Badi

    curl -X POST
    -H “X-Parse-Application-Id: ${APPLICATION_ID}”
    -H “X-Parse-REST-API-Key: ${REST_API_KEY}”
    -H “Content-Type: application/json”
    -d ‘{“score”:1337,”playerName”:”Sean Plott”,”cheatMode”:false}’
    https://api.parse.com/1/classes/GameScore how do we convert this into restassured code?

  • Pingback: REST Assured API for Testing and Parsing JSON big file | shdhumale()

  • Eswar Chandra Maddali

    is rest assured used only to test rest api?

    • Łukasz Rosłonek

      Hi @eswarchandramaddali:disqus ,

      Rest-Assured is basically a REST client, so you can do whatever’s connected with performing HTTP requests, likewise simple web-app

      • Eswar Chandra Maddali

        Thanks!

        • Eswar Chandra Maddali

          hey i am doing rest assured in eclipse .i have a doubt regarding running of program .in what way we have to run whether as a java program or a junit test

          • Łukasz Rosłonek

            Since there’s no main() method, you should run it as a JUnit Test.

  • Eswar Chandra Maddali

    I just kept all my login credentials in a json file.How can i use this file in authentication process.Thanks in advance

  • Gennadii Sirtsov

    Hi Lukasz,
    Do you execute RA tests in parallel or sequentially?

    • Łukasz Rosłonek

      Hi @gennadiisirtsov:disqus
      Since I have lots of asynchronous calls in my scenarios, I usually execute my tests sequentially