net.serenitybdd.screenplay.rest.abilities.CallAnApi Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of serenity-screenplay-rest Show documentation

There is a newer version: 4.2.9

Show newest version

package net.serenitybdd.screenplay.rest.abilities;

import io.restassured.response.Response;
import net.serenitybdd.rest.SerenityRest;
import net.serenitybdd.screenplay.Ability;
import net.serenitybdd.screenplay.Actor;

/**
 * A Screenplay ability that allows an actor to perform REST queries against a specified API.
 * For example:
 * ```
 * Actor sam = Actor.named("Sam the supervisor").whoCan(CallAnApi.at("https://reqres.in"));
 * ```
 */
public class CallAnApi implements Ability {

    private final String baseURL;

    private CallAnApi(String baseURL) {
        this.baseURL = baseURL;
    }

    /**
     * Ability to Call and api at a specified baseUrl
     */
    public static CallAnApi at(String baseURL) {
        return new CallAnApi(baseURL);
    }

    /**
     * Used to access the Actor's ability to CallAnApi from within the Interaction classes, such as GET or PUT
     */
    public static CallAnApi as(Actor actor) {
        return actor.abilityTo(CallAnApi.class);
    }

    public String resolve(String resource) {
        return baseURL + resource;
    }

    public Response getLastResponse() {
        return SerenityRest.lastResponse();
    }

    @Override
    public String toString() {
        return "call an API at " + baseURL;
    }
}