Requestly Documentation

Official documentation for Requestly - Modify, Mock, Record & Debug HTTP requests

Live Documentation • Website • GitHub • Discord

---

📖 About

This repository contains the official documentation for Requestly - a powerful tool for API Mocking, Testing, and Debugging. The documentation covers:

• Browser Extension - HTTP interception and modification for Chrome, Firefox, Edge, and more
• Desktop App - Advanced debugging for mobile apps, desktop software, and simulators
• API Client - Modern API client for designing, testing, and managing APIs
• HTTP Rules - Comprehensive guides for modifying requests and responses
• Mock Server - API mocking and response simulation
• Team Collaboration - Workspace management and team features
• Public APIs - Programmatic access to Requestly features

🚀 Getting Started

Prerequisites

• Node.js (Node.js v19 through v24. LTS versions are preferred.)
• Mintlify CLI

Installation

Clone the repository:

git clone https://github.com/requestly/requestly-docs.git
cd requestly-docs

For Mintlify setup and installation instructions, refer to the Mintlify documentation.

Running Locally

Start the local development server:

mint dev

The documentation will be available at http://localhost:3000

📁 Project Structure

requestly-docs/
├── changelogs/          # Release notes and changelogs
├── general/             # General documentation
│   ├── getting-started/ # Getting started guides
│   ├── api-client/      # API Client documentation
│   ├── http-rules/      # HTTP Rules guides
│   ├── mock-server/     # Mock Server documentation
│   ├── sessions/        # Session recording docs
│   └── team/            # Team & collaboration features
├── guides/              # How-to guides and tutorials
├── public-apis/         # Public API documentation
├── troubleshoot/        # Troubleshooting guides
├── images/              # Image assets
├── docs.json            # Mintlify configuration
└── LICENSE              # License file

📝 Contributing

We welcome contributions from the community! Whether you want to fix a typo, improve existing documentation, or add new guides, your help is appreciated.

Ways to Contribute

1. Fix typos or errors - Submit a PR with corrections
2. Improve existing docs - Enhance clarity, add examples, or update outdated information
3. Add new guides - Create tutorials for specific use cases
4. Community content - Share your Requestly experiences and workflows

Contribution Guidelines

1. Fork the repository and create a new branch for your changes

   git checkout -b feature/your-contribution

2. Make your changes following our documentation standards:

   • Use clear, concise language
   • Include code examples where appropriate
   • Add screenshots or images to illustrate steps
   • Test all code snippets and instructions
   • Use proper Markdown/MDX formatting

3. Test locally using mint dev to preview your changes

4. Submit a Pull Request with:

   • Clear title describing your contribution
   • Description of what you changed and why
   • Screenshots if you made visual changes

Documentation Standards

• Use .mdx format for enhanced formatting capabilities
• Include frontmatter metadata (title, label, slug, description)
• Follow existing formatting conventions
• This documentation is built with Mintlify - refer to their documentation for available components and features

🎯 Community Content

Have a tutorial, guide, or use case to share? Check out our Community Content folder for guidelines on contributing community-driven content.

🐛 Reporting Issues

Found an error in the documentation? Please open an issue with:

• Page URL or file path
• Description of the issue
• Suggested correction (if applicable)
• Screenshots (if relevant)

🔗 Useful Links

• Live Documentation: docs.requestly.com
• Requestly App: app.requestly.io
• Website: requestly.com
• GitHub: github.com/requestly
• Discord Community: rqst.ly/join-community

💬 Support

Need help?

• 📖 Documentation: docs.requestly.com
• 💬 Discord: Join our community
• 🐙 GitHub Discussions: github.com/requestly/requestly/discussions
• 📧 Email: [email protected]

📄 License

This documentation is licensed under the AGPL-3.0 License.

🙏 Acknowledgments

Thank you to all our contributors who help make Requestly documentation better!

---

Built with ❤️ by the Requestly Team
_{Powered by Mintlify}