linkOverview

linkWhat is it?

REST-EZ is a declarative, specification based test framework for HTTP (ex: REST & GraphQL) APIs. In short, you test APIs without writing code (declarative, not procedural).

linkHow does it work?

YAML files define sets of requests & response validations

Each suite can have one or more specs. For each spec, REST-EZ:

1. Builds the request
2. Sends the request to the server
3. Validates the response

linkDocumentation

• Installation
• Getting Started
• Basic Concepts
• Requests
  • Headers
  • Cookies
  • Query Parameters
  • Path Parameters
  • Request Body
    • JSON Body
    • Binary Data
    • URL Encoded Form Data
    • URL Encoded Form Data
    • Multi-Part Form Data
  • File Uploads
  • Additional Options
• Response Validation
  • Status Code Validation
  • Cookie Validation
  • Header Validation
  • Body Validation
    • JSON Path
    • JSON Schema Inline
    • JSON Schema File
    • Swagger / Open API
• Lifecycle Hooks
  • Hook Types
    • JS Inline Functions
    • JS Async Inline Functions
    • JS Modules
  • List of Hooks
    • before_all
    • after_all
    • before_each
    • after_each
    • before_test
    • after_test
  • Hook Context
    • Suite Context
    • Test Context
    • Response Context
• Reusing Specs & DRY
  • Looping
  • Yaml Anchors
  • Run Existing Spec
• Command Line Interface (CLI)
  • Debugging
  • Running Suites in Parallel
  • Reporters
  • Options

linkAcknowledgements

👏👏👏 Enormous thanks to Kiran Mandadi,

Original creator of rest-ez upon which this project is based (forked).

👏👏👏 Thanks to corporate sponsors

• Blossom Finance ethical investments in micro businesses
• LaunchGood crowdfunding incredible Muslims

linkRoadmap & TODO

• ✅ Full support for de-referencing schema $refs
• ✅ Allow specifying node within a schema file using JSON pointer
• ✅ Pass arguments to inline or module-based functions to allow creater re-use
• ✅ Documentation improvements
  • ✅ Upgrade markdown static site generator (something without python dependency)
  • ✅ Example function with arguments usage
  • ✅ JSON schema validation de-referencing schema $refs
  • ✅ Specify node within a schema file using JSON path
  • Examples directly using files within node_modules
• Example of how to use faker.js using reusable function
• Code Quality - add linter/hinter/prettier or whatever spec is used