Official documentation for Requestly - Modify, Mock, Record & Debug HTTP requests
This repository contains the official documentation for Requestly, organized around the main jobs users come to Requestly to do:
- API Testing - Send requests, manage environments, organize collections, and add assertions
- Debugging & Interception - Inspect traffic from browsers, mobile apps, desktop apps, emulators, and runtimes
- Modify Traffic - Rewrite headers, bodies, query params, redirects, and delays without changing application code
- Mock APIs & Responses - Create quick mocks and reusable hosted mock endpoints
- Sessions & Collaboration - Record bug reports, capture API sessions, and share workflows with your team
- Public APIs - Automate Requestly workflows programmatically
- Node.js (Node.js v19 through v24. LTS versions are preferred.)
- Mintlify CLI
Clone the repository:
git clone https://github.com/requestly/requestly-docs.git
cd requestly-docsFor Mintlify setup and installation instructions, refer to the Mintlify documentation.
Start the local development server:
mint devThe documentation will be available at http://localhost:3000
requestly-docs/
├── changelogs/ # Release notes and changelogs
├── general/ # Core product docs and onboarding
│ ├── getting-started/ # Intro, setup, and quick-start flows
│ ├── api-client/ # API testing workflows
│ ├── http-rules/ # Traffic modification workflows
│ ├── http-interceptor/# Traffic inspection and interception workflows
│ ├── mock-server/ # Hosted mocks and response simulation
│ ├── sessions/ # Bug reports, API sessions, and HAR workflows
│ └── team/ # Collaboration and workspaces
├── guides/ # Task-based guides and integration tutorials
├── public-apis/ # Programmatic Requestly APIs
├── troubleshoot/ # Setup and workflow recovery guides
├── images/ # Image assets
├── docs.json # Mintlify configuration
└── LICENSE # License file
We welcome contributions from the community! Whether you want to fix a typo, improve existing documentation, or add new guides, your help is appreciated.
- Fix typos or errors - Submit a PR with corrections
- Improve existing docs - Enhance clarity, add examples, or update outdated information
- Add new guides - Create tutorials for specific use cases
- Community content - Share your Requestly experiences and workflows
-
Fork the repository and create a new branch for your changes
git checkout -b feature/your-contribution
-
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
-
Test locally using
mint devto preview your changes -
Submit a Pull Request with:
- Clear title describing your contribution
- Description of what you changed and why
- Screenshots if you made visual changes
- Use
.mdxformat 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
Have a tutorial, guide, or use case to share? Check out our Community Content folder for guidelines on contributing community-driven content.
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)
- Live Documentation: docs.requestly.com
- Requestly App: app.requestly.io
- Website: requestly.com
- GitHub: github.com/requestly
- Discord Community: rqst.ly/join-community
Need help?
- 📖 Documentation: docs.requestly.com
- 💬 Discord: Join our community
- 🐙 GitHub Discussions: github.com/requestly/requestly/discussions
- 📧 Email: contact@requestly.io
This documentation is licensed under the AGPL-3.0 License.
Thank you to all our contributors who help make Requestly documentation better!
Powered by Mintlify