RestBook Documentation

Welcome to the RestBook documentation! This documentation will guide you through using RestBook, a powerful API request orchestration tool for defining and executing complex REST API workflows using declarative YAML playbooks.

Table of Contents

  1. Getting Started
    • Installation
    • Quick Start Guide
    • Basic Concepts
  2. Playbook Structure
    • Sessions
    • Phases
    • Steps
    • Configuration Options
  3. Features
    • Environment Variables
    • Session Management
    • Parallel Execution
    • Variable Storage and Templates
    • Error Handling and Retries
    • Incremental Execution
  4. CI/CD Integration
    • GitHub Actions
    • Environment Variables
    • Best Practices
  5. Examples
    • Basic Examples
    • Advanced Use Cases
    • Common Patterns

What is RestBook?

RestBook is a powerful API request orchestration tool that lets you define and execute complex REST API workflows using declarative YAML playbooks. Unlike API testing tools, RestBook isn’t about testing endpoints one by one—it’s designed to chain together multiple API calls, manage state between requests, and even resume workflows after failures.

Key Features

  • YAML-Based Playbooks: Define your API workflows in simple, readable YAML files
  • Session Management: Configure and reuse API sessions with authentication
  • Phased Execution: Organize requests into logical phases
  • Variable Management: Store and reuse data between requests
  • Template Rendering: Use variables in requests with template syntax
  • Parallel Execution: Run requests in parallel for improved performance
  • Incremental Execution: Resume playbooks from checkpoints
  • Resilient HTTP Client: Automatic retries, circuit breaking, and rate limiting
  • Flexible Logging: Multiple output formats and configurable log levels
  • Metrics Collection: Monitor and analyze playbook performance, including memory and CPU usage
  • Extensible Architecture: Add custom authentication and checkpoint stores

Documentation Status

This documentation is currently under development. We are in the process of moving content from the README to these dedicated documentation pages. Please check back regularly for updates and new content.

Contributing to Documentation

We welcome contributions to the documentation! If you find any issues or have suggestions for improvements, please feel free to:

  1. Open an issue
  2. Submit a pull request
  3. Contact the maintainers

License

This documentation is part of the RestBook project and is licensed under the MIT License.