RestFlow

A powerful CLI tool for API testing and workflow automation using a simple, human-readable DSL

Why Choose RestFlow?

🚀

Simple DSL

Write API tests in a human-readable format with intuitive syntax that anyone can understand

Variable Substitution

Dynamic variables like uuid, timestamp, and environment-based substitution

🔧

Built-in Assertions

Powerful assertion engine for validating response status, headers, and body content

📊

Multiple Outputs

Console, JSON, and summary formats for different use cases and CI/CD integration

🌍

Environment Support

Support for .env files and BASE_URL configuration for different environments

🏗️

Modular Architecture

Built with NX monorepo structure for maintainability and extensibility

📝

Data Capture

Capture response data for use in subsequent requests with simple capture syntax

🔗

Workflow Automation

Chain multiple API calls together to create complex testing workflows

⚙️

TypeScript Ready

Built with TypeScript for type safety and excellent developer experience

See RestFlow in Action

### Get Todo
GET https://jsonplaceholder.typicode.com/todos/1

> assert status == 200
> assert body.id == 1
> assert body.title contains "delectus"

### Create Post
POST https://jsonplaceholder.typicode.com/posts
Content-Type: application/json

{
  "title": "My New Post",
  "body": "This is the content of my post",
  "userId": 1
}

> assert status == 201
> assert body.title == "My New Post"
> capture postId = body.id