RESTest Documentation

RESTest is a powerful and flexible REST API testing tool written in Python that allows you to create, run and validate API tests through simple JSON files. With RESTest, you can quickly set up test suites for your APIs, validate responses, extract and reuse data between requests, and much more.

WATCH my PyCon IT 2023 presentation (in Italian)

Key Features

• Simple JSON-based Test Definition: Write tests using straightforward JSON syntax
• Session Management: Automatic handling of cookies and authentication tokens
• Variable Storage and Reuse: Extract data from responses and use them in subsequent requests
• Powerful Path Parser: Extract and validate nested JSON values with ease
• Request Authentication: Built-in support for Bearer token authentication
• Comprehensive Testing: Validate response status codes, headers, and body content
• Test Organization: Group tests into logical sections
• Test Chaining: Use data from previous responses in subsequent requests
• Export Capabilities: Generate Postman collections from your tests
• Detailed Logging: Keep track of all requests and responses
• Performance Metrics: Monitor request timing and response sizes

Quick Start

Installation

Install RESTest using pip:

pip install restest

Basic Usage

Create a simple test file (e.g., test.json):

{
  "system": {
    "base_url": "https://api.example.com",
    "log_file": "./restest.log"
  },
  "actions": [
    {
      "method": "get",
      "url": "/users/1",
      "tests": [
        {
          "field": "id",
          "value": 1
        }
      ]
    }
  ]
}

Run the test:

restest test.json

Documentation Chapters

1. Getting Started

2. Test Structure

3. Making Requests

4. Testing Responses

5. Variables and Data

6. Advanced Features

7. Integration and Export

8. Command Line Options

APPENDIX A - Test Modes Reference

APPENDIX B - Path Parser

Contributing

RESTest is an open-source project and welcomes contributions. Visit the GitHub repository to:

• Report issues
• Submit pull requests
• Suggest new features
• Help improve documentation

License

RESTest is released under the GPLv3 License. See the LICENSE file in the project repository for more details.