Show Menu
Cheatography

Rest-Assured: Extract value by GPath Cheat Sheet by

This is for Rest-Assured course in https://giangtester.com/

Json example 1

{
  "store": {
    "book": [
      {
        "category": "reference",
        "author": "Nigel Rees",
        "title": "Sayings of the Century",
        "price": 8.95
      },
      {
        "category": "fiction",
        "author": "Evelyn Waugh",
        "title": "Sword of Honour",
        "price": 12.99
      },
      {
        "category": "fiction",
        "author": "Herman Melville",
        "title": "Moby Dick",
        "isbn": "0-553-21311-3",
        "price": 8.99
      },
      {
        "category": "fiction",
        "author": "J. R. R. Tolkien",
        "title": "The Lord of the Rings",
        "isbn": "0-395-19395-8",
        "price": 22.99
      }
    ],
    "bicycle": {
      "color": "red",
      "price": 19.95
    }
  }
}

Extract value from Example 1

- Read the json: String --> JsonPath
JsonPath jsonPath = JsonPath.from(res);

- First category
jsonPath.getString("store.book[0].category");
//reference

- All category
jsonPath.getList("store.book.category");
//[reference, fiction, fiction, fiction]

- All author that have price > 10
jsonPath.getList("store.book.findAll {it.price > 10}.author");
//[Evelyn Waugh, J. R. R. Tolkien]

- All author that have category = fiction
jsonPath.getList("store.book.findAll {it.category == 'fiction'}.author");
//[Evelyn Waugh, Herman Melville, J. R. R. Tolkien]

- Count number of author
jsonPath.getInt("store.book.author.size()");
//4

- First author that have price > 10
jsonPath.getString("store.book.find {it.price > 10}.author");
//Evelyn Waugh

- Color of bicycle
jsonPath.getString("store.bicycle.color");
//red

Convert to Array or List of Object

- Response

[
  {
    "id": "11",
    "name": "abc"
  }
]

- POJO

@Data
public class Root {
    private String id;
    private String name;
}

- Convert to object

Root root = given()....extract().as(Root[].class)[0];

or

Root root = given()....extract().jsonPath().getList("", Root.class).get(0);
 

Json Example 2 - extract

{
  "foo.bar.baz": {
    "0.2.0": "test"
  }
}

JsonPath.from(json).getString("'foo.bar.baz'.'0.2.0'")
//test


{
  "a-b": "minus",
  "a.b": "dot",
  "a.b-c": "both"
}

JsonPath.from(json).getString("'a.b-c'");
//both

{
  "map": {
    "true": 12.3,
    "false": 15.0
  }
}

JsonPath.from(json).getFloat("map.'false'")
//15.0f

JsonPath.from(json).getFloat("map.'true'")
//12.3f

Json Example 3 - extract

{
  "semester": "Fall 2015",
  "groups": [
    {
      "siteUrl": "http://cphbusinessjb.cloudapp.net/CA2/",
      "error": "NO AUTHOR/CLASS-INFO"
    },
    {
      "siteUrl": "http://ca2-ebski.rhcloud.com/CA2New/",
      "authors": "Ebbe, Kasper, Christoffer",
      "class": "A klassen",
      "group": "Gruppe: Johns Llama Herders A/S"
    },
    {
      "siteUrl": "http://ca2-chrislind.rhcloud.com/CA2Final/",
      "error": "NO AUTHOR/CLASS-INFO"
    },
    {
      "siteUrl": "http://ca2-pernille.rhcloud.com/NYCA2/",
      "authors": "Marta, Jeanette, Pernille",
      "class": "DAT A",
      "group": "Group: MJP"
    },
    {
      "siteUrl": "https://ca2-afn.rhcloud.com:8443/company.jsp",
      "error": "NO AUTHOR/CLASS-INFO"
    },
    {
      "siteUrl": "http://ca-smcphbusiness.rhcloud.com/ca2/index.jsp",
      "authors": "Mikkel, Steffen, B Andersen",
      "class": "A Class Computer Science",
      "group": "1"
    }
  ]
}

JsonPath.from(json).getList("groups.getAt('class')");
//[null, A klassen, null, DAT A, null, A Class Computer Science]

- Additional: how to move null from a list
list.removeAll(Collections.singleton(null));
System.out.println("list = " + list);
//[A klassen, DAT A, A Class Computer Science]

Special cases

//Multiple nested arrays

JsonPath.from(response)
.get("communicationPolicy.rules.flatten()
  .findAll {it.test1 == 'TRANSACTIONAL'}
  .value.flatten().findAll {it.channel == 'EMAIL'}.value");

System.out.println(value);

//Check contains
"response.data.tasks.findAll{ 
    it.triggered_by.contains(restAssuredJsonRootObject.response.data.tasks.find{
    it.name.equals('InvestigateSuggestions')}.id) }.name"

restAssuredJsonRootObject --> refer to root of json
 

Comments

No comments yet. Add yours below!

Add a Comment

Your Comment

Please enter your name.

    Please enter your email address

      Please enter your Comment.

          More Cheat Sheets by Giang.nd2508

          Postman Script 1 Cheat Sheet
          Postman Script 2 Cheat Sheet
          Java_Intermediate: Collection Cheat Sheet