Skip to main content

Reference

Use this section after completing the quick start. It contains the detailed action, property, validation, reporting, and design guides.

I want to...

TaskStart here
Open a browser, click, type, wait, and assertWeb testing
Choose resilient web locatorsWeb locator strategy
Send REST requests and validate responsesAPI testing
Configure browser, API, mobile, retry, or reporting behaviorProperty types
Generate a custom .properties fileProperties Generator
Attach evidence and understand reportsReporting
Diagnose flaky or failed runsHow SHAFT reduces flakiness
Query a database or run a terminal commandDatabase testing and CLI testing

Reference areas

AreaReference
Browser and element actionsGUI actions
REST APIAPI request builder
CLITerminal actions
DatabaseDatabase actions
ConfigurationProperty types
AssertionsValidation overview
Engineering practicesSolution design

Start from the facade namespace for the surface you are testing:

SHAFT.API api = new SHAFT.API("https://jsonplaceholder.typicode.com");

api.get("/todos/1").perform();
api.assertThatResponse().extractedJsonValue("id").isEqualTo("1");