Preacher: Web API Verification without Coding

Preacher verifies API servers, which requests to API servers and verify the response along to given scenarios.

Test scenarios are written only in YAML declaratively, without coding. In spite of that, Preacher can validate your web API flexibly, which enables you to test using real (neither mocks nor sandboxes) backends.

• Responses are analyzed jq or XPath queries

• Validation rules are based on Hamcrest (implemented by PyHamcrest).

The User Guide

• Introduction
  • Targets
  • Comparison to similar tools
  • License
• Quickstart
  • Install
  • Verify Your API
  • Interpret Results
• Frequently Used Options
  • Rich HTML Report
  • Control Console Outputs
  • Allowing Random Errors
  • Concurrent running
• Advanced Usage
  • Default Test
  • Parameterized Test
  • Conditional Scenario
  • Ignore cases

The Reference Guide

• Scenario Structure
  • Scenario
  • Case
  • Request
  • ResponseDescription
  • Description
  • Predicate
  • Parameter
• Extraction
  • Grammer
  • Content Compatibility
• Matcher
  • For Objects
  • For Comparable Values
  • For String Values
  • For Datetime Values
  • For Sequence Values
  • Logical Matchers
  • Custom matchers
• Context
  • Contextual Value Usage
  • Define a Contextual Value
  • Predefined Contextual Values
• YAML Tag
  • !argument: Define an argument
  • !include: Including other YAML files
  • !relative_datetime: Give a relative datetime value with a format
  • !context: Use a Contextual value
• CLI Application
  • Arguments
  • Options
  • Environment Variables Interface