com.jayway.restassured.specification.ResponseSpecification Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of rest-assured Show documentation
Show all versions of rest-assured Show documentation
Java DSL for easy testing of REST services
/*
* Copyright 2010 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.jayway.restassured.specification;
import groovyx.net.http.ContentType;
import org.hamcrest.Matcher;
import java.util.Map;
/**
* Allows you to specify how the expected response must look like in order for a test to pass.
*/
public interface ResponseSpecification extends RequestSender {
/**
* Expect that the response content conforms to one or more Hamcrest matchers. E.g.
*
* // Expect that the response content (body) contains the string "winning-numbers"
* expect().content(containsString("winning-numbers")).when().get("/lotto");
*
* // Expect that the response content (body) contains the string "winning-numbers" and "winners"
* expect().content(containsString("winning-numbers"), containsString("winners")).when().get("/lotto");
*
* @param matcher The hamcrest matcher that must response content must match.
* @param additionalMatchers Optionally additional hamcrest matchers that must return true.
* @return The response com.jayway.restassured.specification
*/
ResponseSpecification content(Matcher matcher, Matcher...additionalMatchers);
/**
* Expect that the JSON or XML response content conforms to one or more Hamcrest matchers.
* JSON example
*
* Assume that a GET request to "/lotto" returns a JSON response containing:
*
* { "lotto":{
* "lottoId":5,
* "winning-numbers":[2,45,34,23,7,5,3],
* "winners":[{
* "winnerId":23,
* "numbers":[2,45,34,23,3,5]
* },{
* "winnerId":54,
* "numbers":[52,3,12,11,18,22]
* }]
* }}
*
*
* You can verify that the lottoId is equal to 5 like this:
*
* expect().content("lotto.lottoId", equalTo(5)).when().get("/lotto");
*
*
* You can also verify that e.g. one of the the winning numbers is 45.
*
* expect().content("lotto.winning-numbers", hasItem(45)).when().get("/lotto");
*
*
* Or both at the same time:
*
* expect().content("lotto.lottoId", equalTo(5)).and().content("lotto.winning-numbers", hasItem(45)).when().get("/lotto");
*
*
* or a slightly short version:
*
* expect().content("lotto.lottoId", equalTo(5), "lotto.winning-numbers", hasItem(45)).when().get("/lotto");
*
*
* XML example
*
* Assume that a GET request to "/xml" returns a XML response containing:
*
* <greeting>
* <firstName>John</firstName>
* <lastName>Doe</lastName>
* </greeting>
*
*
*
* You can now verify that the firstName is equal to "John" like this:
*
* expect().content("greeting.firstName", equalTo("John")).when().get("/xml");
*
*
* To verify both the first name and last name you can do like this:
*
* expect().content("greeting.firstName", equalTo("John")).and().content("greeting.lastName", equalTo("Doe")).when().get("/xml");
*
*
* Or the slightly shorter version of:
*
* expect().content("greeting.firstName", equalTo("John"), "greeting.lastName", equalTo("Doe")).when().get("/xml");
*
* Notes
*
* Note that if the response content type is not of type application/xml or application/json you
* cannot use this verification.
*
*
*
* The only difference between the content and body methods are of syntactic nature.
*
*
* @param matcher The hamcrest matcher that must response content must match.
* @param additionalKeyMatcherPairs Optionally additional hamcrest matchers that must return true.
* @return The response com.jayway.restassured.specification
*/
ResponseSpecification content(String key, Matcher matcher, Object...additionalKeyMatcherPairs);
/**
* Expect that the response status code matches the given Hamcrest matcher. E.g.
*
* expect().statusCode(equalTo(200)).when().get("/something");
*
*
* @param expectedStatusCode The expected status code matcher.
* @return The response com.jayway.restassured.specification
*/
ResponseSpecification statusCode(Matcher expectedStatusCode);
/**
* Expect that the response status code matches an integer. E.g.
*
* expect().statusCode(200).when().get("/something");
*
*
* This is the same as:
*
* expect().statusCode(equalTo(200)).when().get("/something");
*
* @param expectedStatusCode The expected status code.
* @return The response com.jayway.restassured.specification
*/
ResponseSpecification statusCode(int expectedStatusCode);
/**
* Expect that the response status line matches the given Hamcrest matcher. E.g.
*
* expect().statusLine(equalTo("No Content")).when().get("/something");
*
*
* @param expectedStatusLine The expected status line matcher.
* @return The response com.jayway.restassured.specification
*/
ResponseSpecification statusLine(Matcher expectedStatusLine);
/**
* Expect that the response status line matches the given String. E.g.
*
* expect().statusLine("No Content").when().get("/something");
*
*
* This is the same as:
*
* expect().statusLine(equalTo("No Content")).when().get("/something");
*
*
* @param expectedStatusLine The expected status line.
* @return The response com.jayway.restassured.specification
*/
ResponseSpecification statusLine(String expectedStatusLine);
/**
* Expect that response headers matches those specified in a Map.
*
* E.g. expect that the response of the GET request to "/something" contains header headerName1=headerValue1
* and headerName2=headerValue2:
*
* Map expectedHeaders = new HashMap();
* expectedHeaders.put("headerName1", "headerValue1"));
* expectedHeaders.put("headerName2", "headerValue2");
*
* expect().response().headers(expectedHeaders).when().get("/something");
*
*
*
*
* You can also use Hamcrest matchers:
*
* Map expectedHeaders = new HashMap();
* expectedHeaders.put("Content-Type", containsString("charset=UTF-8"));
* expectedHeaders.put("Content-Length", "160");
*
* expect().headers(expectedHeaders).when().get("/something");
*
*
*
* @param expectedHeaders The Map of expected response headers
* @return The response com.jayway.restassured.specification
*/
ResponseSpecification headers(Map expectedHeaders);
/**
* Expect that response headers matches the supplied headers and values.
*
* E.g. expect that the response of the GET request to "/something" contains header Pragma=no-cache
* and Content-Encoding=gzip:
*
* expect().headers("Pragma", "no-cache", "Content-Encoding", "gzip").when().get("/something");
*
*
*
*
* You can also use Hamcrest matchers:
*
* expect().response().headers("Content-Type", containsString("application/json"), "Pragma", equalsTo("no-cache")).when().get("/something");
*
*
* and you can even mix string matching and hamcrest matching:
*
* expect().headers("Content-Type", containsString("application/json"), "Pragma", "no-cache").when().get("/something");
*
*
*
* @param expectedHeaders A list of expected "header name" - "header value" pairs.
* @return The response com.jayway.restassured.specification
*/
ResponseSpecification headers(String firstExpectedHeaderName, Object...expectedHeaders);
/**
* Expect that a response header matches the supplied header name and hamcrest matcher.
*
* E.g. expect that the response of the GET request to "/something" contains header Pragma=no-cache:
*
* expect().header("Pragma", containsString("no")).when().get("/something");
*
*
*
*
* You can also expect several headers:
*
* expect().header("Pragma", equalsTo("no-cache")),and().header("Content-Encoding", containsString("zip")).when().get("/something");
*
* Also take a look at {@link #headers(String, Object...))} for a short version of passing multiple headers.
*
*
* @param headerName The name of the expected header
* @param expectedValueMatcher The Hamcrest matcher that must conform to the value
* @return The response com.jayway.restassured.specification
*/
ResponseSpecification header(String headerName, Matcher expectedValueMatcher);
/**
* Expect that a response header matches the supplied name and value.
*
* E.g. expect that the response of the GET request to "/something" contains header Pragma=no-cache:
*
* expect().header("Pragma", "no-cache").when().get("/something");
*
*
*
*
* You can also expect several headers:
*
* expect().header("Pragma", "no-cache"),and().header("Content-Encoding", "gzip").when().get("/something");
*
* Also take a look at {@link #headers(String, Object...))} for a short version of passing multiple headers.
*
*
* @param headerName The name of the expected header
* @param expectedValue The value of the expected header
* @return The response com.jayway.restassured.specification
*/
ResponseSpecification header(String headerName, String expectedValue);
/**
* Expect that response cookies matches those specified in a Map.
*
* E.g. expect that the response of the GET request to "/something" contains cookies cookieName1=cookieValue1
* and cookieName2=cookieValue2:
*
* Map expectedCookies = new HashMap();
* expectedCookies.put("cookieName1", "cookieValue1"));
* expectedCookies.put("cookieName2", "cookieValue2");
*
* expect().response().cookies(expectedCookies).when().get("/something");
*
*
*
*
* You can also use Hamcrest matchers:
*
* Map expectedCookies = new HashMap();
* expectedCookies.put("cookieName1", containsString("Value1"));
* expectedCookies.put("cookieName2", "cookieValue2");
*
* expect().cookies(expectedCookies).when().get("/something");
*
*
*
* @param expectedCookies A Map of expected response cookies
* @return The response com.jayway.restassured.specification
*/
ResponseSpecification cookies(Map expectedCookies);
/**
* Expect that response cookies matches the supplied cookie names and values.
*
* E.g. expect that the response of the GET request to "/something" contains cookies cookieName1=cookieValue1
* and cookieName2=cookieValue2:
*
* expect().cookies("cookieName1", "cookieValue1", "cookieName2", "cookieValue2").when().get("/something");
*
*
*
*
* You can also use Hamcrest matchers:
*
* expect().response().cookies("cookieName1", containsString("Value1"), "cookieName2", equalsTo("cookieValue2")).when().get("/something");
*
*
* and you can even mix string matching and hamcrest matching:
*
* expect().cookies("cookieName1", containsString("Value1"), "cookieName2", "cookieValue2").when().get("/something");
*
*
*
* @param expectedCookieNameValuePairs A list of expected "cookie name" - "cookie value" pairs.
* @return The response com.jayway.restassured.specification
*/
ResponseSpecification cookies(String firstExpectedCookieName, Object...expectedCookieNameValuePairs);
/**
* Expect that a response cookie matches the supplied cookie name and hamcrest matcher.
*
* E.g. expect that the response of the GET request to "/something" contain cookie cookieName1=cookieValue1
*
* expect().cookie("cookieName1", containsString("Value1")).when().get("/something");
*
*
*
*
* You can also expect several cookies:
*
* expect().cookie("cookieName1", equalsTo("cookieValue1")),and().cookie("cookieName2", containsString("Value2")).when().get("/something");
*
* Also take a look at {@link #cookies(String, Object...))} for a short version of passing multiple cookies.
*
*
* @param cookieName The name of the expected cookie
* @param expectedValueMatcher The Hamcrest matcher that must conform to the value
* @return The response com.jayway.restassured.specification
*/
ResponseSpecification cookie(String cookieName, Matcher expectedValueMatcher);
/**
* Expect that a response cookie matches the supplied name and value.
*
* E.g. expect that the response of the GET request to "/something" contain cookie cookieName1=cookieValue1:
*
* expect().cookie("cookieName1", "cookieValue1").when().get("/something");
*
*
*
*
* You can also expect several cookies:
*
* expect().cookie("cookieName1", "cookieValue1"),and().cookie("cookieName2", "cookieValue2").when().get("/something");
*
* Also take a look at {@link #cookies(String, Object...))} for a short version of passing multiple cookies.
*
*
* @param cookieName The name of the expected cookie
* @param expectedValue The value of the expected cookie
* @return The response com.jayway.restassured.specification
*/
ResponseSpecification cookie(String cookieName, String expectedValue);
/**
* Set the response content type to be contentType.
* Note that this will affect the way the response is decoded.
* E,g. if you can't use JSON/XML matching (see e.g. {@link #body(String, Matcher, Object...)}) if you specify a
* content-type of "text/plain". If you don't specify the response content type REST Assured will automatically try to
* figure out which content type to use.
*
* @param contentType The content type of the response.
* @return The response com.jayway.restassured.specification
*/
ResponseSpecification contentType(ContentType contentType);
/**
* Expect that the response body conforms to one or more Hamcrest matchers. E.g.
*
* // Expect that the response body (content) contains the string "winning-numbers"
* expect().body(containsString("winning-numbers")).when().get("/lotto");
*
* // Expect that the response body (content) contains the string "winning-numbers" and "winners"
* expect().body(containsString("winning-numbers"), containsString("winners")).when().get("/lotto");
*
* @param matcher The hamcrest matcher that must response body must match.
* @param additionalMatchers Optionally additional hamcrest matchers that must return true.
* @return The response com.jayway.restassured.specification
*/
ResponseSpecification body(Matcher matcher, Matcher...additionalMatchers);
/**
* Expect that the JSON or XML response body conforms to one or more Hamcrest matchers.
* JSON example
*
* Assume that a GET request to "/lotto" returns a JSON response containing:
*
* { "lotto":{
* "lottoId":5,
* "winning-numbers":[2,45,34,23,7,5,3],
* "winners":[{
* "winnerId":23,
* "numbers":[2,45,34,23,3,5]
* },{
* "winnerId":54,
* "numbers":[52,3,12,11,18,22]
* }]
* }}
*
*
* You can verify that the lottoId is equal to 5 like this:
*
* expect().body("lotto.lottoId", equalTo(5)).when().get("/lotto");
*
*
* You can also verify that e.g. one of the the winning numbers is 45.
*
* expect().body("lotto.winning-numbers", hasItem(45)).when().get("/lotto");
*
*
* Or both at the same time:
*
* expect().body("lotto.lottoId", equalTo(5)).and().body("lotto.winning-numbers", hasItem(45)).when().get("/lotto");
*
*
* or a slightly short version:
*
* expect().body("lotto.lottoId", equalTo(5), "lotto.winning-numbers", hasItem(45)).when().get("/lotto");
*
*
* XML example
*
* Assume that a GET request to "/xml" returns a XML response containing:
*
* <greeting>
* <firstName>John</firstName>
* <lastName>Doe</lastName>
* </greeting>
*
*
*
* You can now verify that the firstName is equal to "John" like this:
*
* expect().body("greeting.firstName", equalTo("John")).when().get("/xml");
*
*
* To verify both the first name and last name you can do like this:
*
* expect().body("greeting.firstName", equalTo("John")).and().body("greeting.lastName", equalTo("Doe")).when().get("/xml");
*
*
* Or the slightly shorter version of:
*
* expect().body("greeting.firstName", equalTo("John"), "greeting.lastName", equalTo("Doe")).when().get("/xml");
*
* Notes
*
* Note that if the response body type is not of type application/xml or application/json you
* cannot use this verification.
*
*
*
* The only difference between the content and body methods are of syntactic nature.
*
*
* @param matcher The hamcrest matcher that must response body must match.
* @param additionalKeyMatcherPairs Optionally additional hamcrest matchers that must return true.
* @return The response com.jayway.restassured.specification
*/
ResponseSpecification body(String key, Matcher matcher, Object...additionalKeyMatcherPairs);
/**
* Syntactic sugar, e.g.
*
* expect().body(containsString("OK")).when().get("/something");
*
*
* is that same as:
*
* expect().body(containsString("OK")).get("/something");
*
*
* @return the response com.jayway.restassured.specification
*/
ResponseSpecification when();
/**
* Returns the request com.jayway.restassured.specification so that you can define the properties of the request.
*
* expect().body(containsString("OK")).given().parameters("param1", "value1").when().get("/something");
*
*
* @return the request com.jayway.restassured.specification
*/
RequestSpecification given();
/**
* Syntactic sugar, e.g.
*
* expect().that().body(containsString("OK")).when().get("/something");
*
*
* is that same as:
*
* expect().body(containsString("OK")).get("/something");
*
*
* @return the response com.jayway.restassured.specification
*/
ResponseSpecification that();
/**
* Returns the request com.jayway.restassured.specification so that you can define the properties of the request.
*
* expect().body(containsString("OK")).and().request().parameters("param1", "value1").when().get("/something");
*
*
* @return the request com.jayway.restassured.specification
*/
RequestSpecification request();
/**
* Syntactic sugar, e.g.
*
* expect().response().body(containsString("OK")).when().get("/something");
*
*
* is that same as:
*
* expect().body(containsString("OK")).get("/something");
*
*
* @return the response com.jayway.restassured.specification
*/
ResponseSpecification response();
/**
* Syntactic sugar, e.g.
*
* expect().body(containsString("OK")).and().body(containsString("something else")).when().get("/something");
*
*
* is that same as:
*
* expect().body(containsString("OK")).body(containsString("something else")).when().get("/something");
*
*
* @return the response com.jayway.restassured.specification
*/
ResponseSpecification and();
/**
* Returns the request com.jayway.restassured.specification so that you can define the properties of the request.
*
* expect().body(containsString("OK")).and().with().request().parameters("param1", "value1").get("/something");
*
*
* @return the request com.jayway.restassured.specification
*/
RequestSpecification with();
/**
* Syntactic sugar, e.g.
*
* expect().body(containsString("OK")).then().get("/something");
*
*
* is that same as:
*
* expect().body(containsString("OK")).get("/something");
*
*
* @return the response com.jayway.restassured.specification
*/
ResponseSpecification then();
/**
* Syntactic sugar, e.g.
*
* expect().body(containsString("OK")).and().expect().body(containsString("something else")).when().get("/something");
*
*
* is that same as:
*
* * expect().body(containsString("OK")).and().body(containsString("something else")).when().get("/something");
*
*
* @return the response com.jayway.restassured.specification
*/
ResponseSpecification expect();
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy