Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/osandadeshan/rest-assured-demo
A sample project to demonstrate API automation for GET, POST, PUT, PATCH & DELETE operations using Rest Assured and Java
https://github.com/osandadeshan/rest-assured-demo
automation rest-api restassured testng
Last synced: about 19 hours ago
JSON representation
A sample project to demonstrate API automation for GET, POST, PUT, PATCH & DELETE operations using Rest Assured and Java
- Host: GitHub
- URL: https://github.com/osandadeshan/rest-assured-demo
- Owner: osandadeshan
- Created: 2020-02-10T10:18:43.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-05-20T04:08:02.000Z (over 2 years ago)
- Last Synced: 2023-02-27T12:17:01.299Z (over 1 year ago)
- Topics: automation, rest-api, restassured, testng
- Language: Java
- Homepage:
- Size: 27.3 KB
- Stars: 3
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://travis-ci.org/rest-assured/rest-assured)
[](https://maven-badges.herokuapp.com/maven-central/io.rest-assured/rest-assured)
[](http://www.javadoc.io/doc/io.rest-assured/rest-assured)
Testing and validation of REST services in Java is harder than in dynamic languages
such as Ruby and Groovy. REST Assured brings the simplicity of using these
languages into the Java domain.
## News
* 2020-01-17: REST Assured [4.2.0](http://dl.bintray.com/johanhaleby/generic/rest-assured-4.2.0-dist.zip) is released. It adds a module bringing [Kotlin extension functions](https://github.com/rest-assured/rest-assured/wiki/Usage#kotlin-extension-module-for-spring-mockmvc) to [Spring Mock Mvc](https://github.com/rest-assured/rest-assured/wiki/Usage#spring-mock-mvc-module), support for Jakarta EE JSON Binding (JSON-B) specification using Eclipse Yasson, as well as [blacklisting](https://github.com/rest-assured/rest-assured/wiki/Usage#blacklist-headers-from-logging) headers from being logged and other improvements. See [release notes](https://github.com/rest-assured/rest-assured/wiki/ReleaseNotes42) and [change log](https://raw.githubusercontent.com/rest-assured/rest-assured/master/changelog.txt) for more details.
* 2019-10-02: REST Assured [4.1.2](http://dl.bintray.com/johanhaleby/generic/rest-assured-4.1.2-dist.zip) is released. It adds support for Java 13 as well as fixing some issues with the [kotlin extension module](https://github.com/rest-assured/rest-assured/wiki/Usage#kotlin-extension-module). Please see [change log](https://raw.githubusercontent.com/rest-assured/rest-assured/master/changelog.txt) for details.
* 2019-09-06: Johan elaborates on some of the benefits of using the new [Kotlin API](https://github.com/rest-assured/rest-assured/wiki/Usage#kotlin-extension-module) in [this](http://code.haleby.se/2019/09/06/rest-assured-in-kotlin/) blog post.
[Older News](https://github.com/rest-assured/rest-assured/wiki/OldNews)
## Examples
Here's an example of how to make a GET request and validate the JSON or XML response:
```java
get("/lotto").then().assertThat().body("lotto.lottoId", equalTo(5));
```
Get and verify all winner ids:
```java
get("/lotto").then().assertThat().body("lotto.winners.winnerId", hasItems(23, 54));
```
Using parameters:
```java
given().
param("key1", "value1").
param("key2", "value2").
when().
post("/somewhere").
then().
body(containsString("OK"));
```
Using X-Path (XML only):
```java
given().
params("firstName", "John", "lastName", "Doe").
when().
post("/greetMe").
then().
body(hasXPath("/greeting/firstName[text()='John']")).
```
Need authentication? REST Assured provides several authentication mechanisms:
```java
given().auth().basic(username, password).when().get("/secured").then().statusCode(200);
```
Getting and parsing a response body:
```java
// Example with JsonPath
String json = get("/lotto").asString();
List winnderIds = from(json).get("lotto.winners.winnerId");
// Example with XmlPath
String xml = post("/shopping").andReturn().body().asString();
Node category = from(xml).get("shopping.category[0]");
```
REST Assured supports any HTTP method but has explicit support for *POST*, *GET*, *PUT*, *DELETE*, *OPTIONS*, *PATCH* and *HEAD* and includes specifying and validating e.g. parameters, headers, cookies and body easily.
## Documentation
* [Getting started](https://github.com/rest-assured/rest-assured/wiki/GettingStarted)
* [Downloads](https://github.com/rest-assured/rest-assured/wiki/Downloads)
* [Usage Guide](https://github.com/rest-assured/rest-assured/wiki/Usage) (click [here](https://github.com/rest-assured/rest-assured/wiki/Usage_Legacy) for legacy documentation)
* [Javadoc](http://www.javadoc.io/doc/io.rest-assured/rest-assured/4.2.0)
* [Rest Assured Javadoc](http://static.javadoc.io/io.rest-assured/rest-assured/4.2.0/io/restassured/RestAssured.html)
* [Rest AssuredMockMvc Javadoc](http://static.javadoc.io/io.rest-assured/spring-mock-mvc/4.1.0/io/restassured/module/mockmvc/RestAssuredMockMvc.html)
* [XmlPath Javadoc](http://static.javadoc.io/io.rest-assured/xml-path/4.2.0/io/restassured/path/xml/XmlPath.html)
* [JsonPath Javadoc](http://static.javadoc.io/io.rest-assured/json-path/4.2.0/io/restassured/path/json/JsonPath.html)
* [Release Notes](https://github.com/rest-assured/rest-assured/wiki/ReleaseNotes)
* [FAQ](https://github.com/rest-assured/rest-assured/wiki/FAQ)
## Support and discussion
Join the mailing list at our [Google group](http://groups.google.com/group/rest-assured).
## Links
* [Change log](https://github.com/rest-assured/rest-assured/raw/master/changelog.txt)
* REST Assured on [openhub](https://www.openhub.net/p/rest-assured)
* [Mailing list](http://groups.google.com/group/rest-assured) for questions and support