ReDocs

Transform your API documentation into interactive Caido replay sessions in seconds!

---

Table of Contents

• Overview
• Features
• Installation
• Quick Start
• Documentation
• Feedback & Issues
• License

Overview

ReDocs is a powerful Caido plugin that bridges the gap between API documentation and security testing by automatically converting Postman Collections, OpenAPI specifications, and Insomnia exports into ready-to-use replay sessions. Built specifically for penetration testers and security researchers, ReDocs integrates seamlessly with Caido's workflow to enhance your security testing capabilities.

Transform your API docs into actionable security tests - because great security starts with great tooling!

Features

Smart Import Engine

• Drag & Drop Import: One-click import for Postman Collections, OpenAPI specs, Insomnia exports, and Postman Environment files
• Auto-Detection: Intelligent file format recognition with confidence scoring
• Format Support: Postman Collection v2.1, OpenAPI 3.x (JSON), Insomnia export (JSON), Bruno OpenCollection (.yaml/.yml), Postman Environment (JSON). See docs/ for example files (Postman, OpenAPI, Insomnia, Bruno, environment).
• Error Handling: Comprehensive validation with detailed error messages

Authentication Management

• Auto-Detection: Automatic detection of API authentication methods
• Smart Replacement: Intelligently replaces conflicting authentication headers
• Bearer Token: JWT tokens and API keys in Authorization header
• Basic Auth: Username/password combinations with base64 encoding
• API Key: Custom headers like X-API-Key, Authorization
• Custom Headers: Any custom authentication scheme support
• Hostname Override: Configure custom hostnames for different environments

Environment Variables

• Environment Import: Import Postman Environment files with all variables and secrets
• Auto-Detection: Automatically detect sensitive variables (tokens, keys, passwords) and mark as secrets
• Variable Management: Create new Caido environments with imported variables ready for use
• Collision Handling: Smart naming prevents overwrites (Dev, Dev-1, Dev-2, etc.)
• Secret Detection: Intelligent detection of sensitive data based on variable names and patterns
• Bulk Import: Import multiple environment files without conflicts

Session Organization

• Intelligent Naming: Sessions named as METHOD /endpoint for easy navigation
• Collection Management: Dedicated collections for each imported API with auto-incremental naming
• Duplicate Handling: Automatically creates Collection1, Collection2, etc. for repeat imports
• Bulk Operations: Process hundreds of endpoints simultaneously
• Path Preservation: Full path parameters and query strings maintained

Professional Integration

• Caido Native: Seamless integration with Caido's Replay functionality
• Modern UI: Beautiful interface matching Caido's theme with dark mode
• Progress Tracking: Real-time feedback with processing indicators
• Zero Configuration: Works out-of-the-box with sensible defaults

Installation

Via Caido's Plugin Store (Recommended)

1. Open Caido
2. Navigate to Settings > Plugins
3. Click the Plugin Store tab
4. Search for "ReDocs"
5. Click Install

Manual Installation

1. Download the latest plugin_package.zip from the Releases page
2. Open Caido
3. Navigate to Plugins
4. Click Install Package and select the downloaded ZIP file

Quick Start

First Import

1. Prepare Your File:

   • Postman: Export your collection as JSON (v2.1). Example: docs/example-postman.json
   • OpenAPI: Save your spec as JSON (3.x). Example: docs/example-openapi.json
   • Insomnia: Use Export to get a JSON file. Example: docs/example-insomnia.json
   • Bruno: Use Share → Export as Postman or OpenAPI, or use OpenCollection YAML (.yaml/.yml). Example: docs/example-bruno.yaml
   • Environments: Export Postman environment as JSON. Example: docs/example-environment.json (filename should contain "environment" or "env")
   • Keep file size under 10MB for best performance

2. Import to ReDocs:

   • Open ReDocs from the Caido sidebar
   • Drag and drop your file onto the upload area
   • Or click "Choose File" to browse for it

3. Configure Authentication:

   • ReDocs automatically detects authentication methods
   • Provide your API credentials when prompted
   • Add custom hostname to override default endpoints (optional)
   • Skip this step if authentication isn't required
   • Smart header replacement prevents authentication conflicts

4. Import Environment Variables (Optional):

   • Import Postman Environment files to set up API variables
   • ReDocs automatically creates new Caido environments with collision-safe naming
   • Sensitive variables (tokens, keys) are automatically marked as secrets
   • Use imported variables in your replay sessions for dynamic testing

5. Start Testing:

   • Navigate to the Replay section in Caido
   • Find your imported sessions organized in dedicated collections
   • Each API endpoint becomes a separate replay session ready for security testing
   • Use your imported environment variables in replay sessions

Documentation

• In-app: Click the "Docs" button in ReDocs for guides, quick start, and troubleshooting.
• Example files: The docs/ folder contains sample files for every supported format (Postman, OpenAPI, Insomnia, Bruno YAML, Postman environment). Use them to verify imports. See docs/README.md.

Feedback & Issues

If you encounter any issues or have suggestions for improvements, please:

• Report bugs and feature requests on our GitHub repository
• Share your security testing workflows and use cases
• Contribute to the growing knowledge base

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made with ❤️ by Amr Elsagaei for the Caido and security community