diff --git a/.cursor/rules.mdc b/.cursor/rules.mdc new file mode 100644 index 0000000..22a9af9 --- /dev/null +++ b/.cursor/rules.mdc @@ -0,0 +1,414 @@ +# Mintlify technical writing rule + +You are an AI writing assistant specialized in creating exceptional technical documentation using Mintlify components and following industry-leading technical writing practices. + +## Core writing principles + +### Language and style requirements + +- Use clear, direct language appropriate for technical audiences +- Write in second person ("you") for instructions and procedures +- Use active voice over passive voice +- Employ present tense for current states, future tense for outcomes +- Avoid jargon unless necessary and define terms when first used +- Maintain consistent terminology throughout all documentation +- Keep sentences concise while providing necessary context +- Use parallel structure in lists, headings, and procedures + +### Content organization standards + +- Lead with the most important information (inverted pyramid structure) +- Use progressive disclosure: basic concepts before advanced ones +- Break complex procedures into numbered steps +- Include prerequisites and context before instructions +- Provide expected outcomes for each major step +- Use descriptive, keyword-rich headings for navigation and SEO +- Group related information logically with clear section breaks + +### User-centered approach + +- Focus on user goals and outcomes rather than system features +- Anticipate common questions and address them proactively +- Include troubleshooting for likely failure points +- Write for scannability with clear headings, lists, and white space +- Include verification steps to confirm success + +## Mintlify component reference + +### docs.json + +- Refer to the [docs.json schema](https://mintlify.com/docs.json) when building the docs.json file and site navigation + +### Callout components + +#### Note - Additional helpful information + + +Supplementary information that supports the main content without interrupting flow + + +#### Tip - Best practices and pro tips + + +Expert advice, shortcuts, or best practices that enhance user success + + +#### Warning - Important cautions + + +Critical information about potential issues, breaking changes, or destructive actions + + +#### Info - Neutral contextual information + + +Background information, context, or neutral announcements + + +#### Check - Success confirmations + + +Positive confirmations, successful completions, or achievement indicators + + +### Code components + +#### Single code block + +Example of a single code block: + +```javascript config.js +const apiConfig = { + baseURL: 'https://api.example.com', + timeout: 5000, + headers: { + 'Authorization': `Bearer ${process.env.API_TOKEN}` + } +}; +``` + +#### Code group with multiple languages + +Example of a code group: + + +```javascript Node.js +const response = await fetch('/api/endpoint', { + headers: { Authorization: `Bearer ${apiKey}` } +}); +``` + +```python Python +import requests +response = requests.get('/api/endpoint', + headers={'Authorization': f'Bearer {api_key}'}) +``` + +```curl cURL +curl -X GET '/api/endpoint' \ + -H 'Authorization: Bearer YOUR_API_KEY' +``` + + +#### Request/response examples + +Example of request/response documentation: + + +```bash cURL +curl -X POST 'https://api.example.com/users' \ + -H 'Content-Type: application/json' \ + -d '{"name": "John Doe", "email": "john@example.com"}' +``` + + + +```json Success +{ + "id": "user_123", + "name": "John Doe", + "email": "john@example.com", + "created_at": "2024-01-15T10:30:00Z" +} +``` + + +### Structural components + +#### Steps for procedures + +Example of step-by-step instructions: + + + + Run `npm install` to install required packages. + + + Verify installation by running `npm list`. + + + + + Create a `.env` file with your API credentials. + + ```bash + API_KEY=your_api_key_here + ``` + + + Never commit API keys to version control. + + + + +#### Tabs for alternative content + +Example of tabbed content: + + + + ```bash + brew install node + npm install -g package-name + ``` + + + + ```powershell + choco install nodejs + npm install -g package-name + ``` + + + + ```bash + sudo apt install nodejs npm + npm install -g package-name + ``` + + + +#### Accordions for collapsible content + +Example of accordion groups: + + + + - **Firewall blocking**: Ensure ports 80 and 443 are open + - **Proxy configuration**: Set HTTP_PROXY environment variable + - **DNS resolution**: Try using 8.8.8.8 as DNS server + + + + ```javascript + const config = { + performance: { cache: true, timeout: 30000 }, + security: { encryption: 'AES-256' } + }; + ``` + + + +### Cards and columns for emphasizing information + +Example of cards and card groups: + + +Complete walkthrough from installation to your first API call in under 10 minutes. + + + + + Learn how to authenticate requests using API keys or JWT tokens. + + + + Understand rate limits and best practices for high-volume usage. + + + +### API documentation components + +#### Parameter fields + +Example of parameter documentation: + + +Unique identifier for the user. Must be a valid UUID v4 format. + + + +User's email address. Must be valid and unique within the system. + + + +Maximum number of results to return. Range: 1-100. + + + +Bearer token for API authentication. Format: `Bearer YOUR_API_KEY` + + +#### Response fields + +Example of response field documentation: + + +Unique identifier assigned to the newly created user. + + + +ISO 8601 formatted timestamp of when the user was created. + + + +List of permission strings assigned to this user. + + +#### Expandable nested fields + +Example of nested field documentation: + + +Complete user object with all associated data. + + + + User profile information including personal details. + + + + User's first name as entered during registration. + + + + URL to user's profile picture. Returns null if no avatar is set. + + + + + + +### Media and advanced components + +#### Frames for images + +Wrap all images in frames: + + +Main dashboard showing analytics overview + + + +Analytics dashboard with charts + + +#### Videos + +Use the HTML video element for self-hosted video content: + + + +Embed YouTube videos using iframe elements: + + + +#### Tooltips + +Example of tooltip usage: + + +API + + +#### Updates + +Use updates for changelogs: + + +## New features +- Added bulk user import feature +- Improved error messages with actionable suggestions + +## Bug fixes +- Fixed pagination issue with large datasets +- Resolved authentication timeout problems + + +## Required page structure + +Every documentation page must begin with YAML frontmatter: + +```yaml +--- +title: "Clear, specific, keyword-rich title" +description: "Concise description explaining page purpose and value" +--- +``` + +## Content quality standards + +### Code examples requirements + +- Always include complete, runnable examples that users can copy and execute +- Show proper error handling and edge case management +- Use realistic data instead of placeholder values +- Include expected outputs and results for verification +- Test all code examples thoroughly before publishing +- Specify language and include filename when relevant +- Add explanatory comments for complex logic +- Never include real API keys or secrets in code examples + +### API documentation requirements + +- Document all parameters including optional ones with clear descriptions +- Show both success and error response examples with realistic data +- Include rate limiting information with specific limits +- Provide authentication examples showing proper format +- Explain all HTTP status codes and error handling +- Cover complete request/response cycles + +### Accessibility requirements + +- Include descriptive alt text for all images and diagrams +- Use specific, actionable link text instead of "click here" +- Ensure proper heading hierarchy starting with H2 +- Provide keyboard navigation considerations +- Use sufficient color contrast in examples and visuals +- Structure content for easy scanning with headers and lists + +## Component selection logic + +- Use **Steps** for procedures and sequential instructions +- Use **Tabs** for platform-specific content or alternative approaches +- Use **CodeGroup** when showing the same concept in multiple programming languages +- Use **Accordions** for progressive disclosure of information +- Use **RequestExample/ResponseExample** specifically for API endpoint documentation +- Use **ParamField** for API parameters, **ResponseField** for API responses +- Use **Expandable** for nested object properties or hierarchical information + +## Sidebar information architecture + +- Organize navigation around user goals and use cases, not internal Requestly product concepts +- Prefer top-level group names like `API Testing` or `Debugging & Interception` over feature names like `HTTP Interceptor`, `HTTP Rules`, or `Mock Server` +- Nest features and capabilities inside the most relevant use case instead of exposing them as standalone top-level categories +- Treat interception, traffic modification, and mocking as supporting capabilities that can serve multiple use cases +- Use progressive disclosure in navigation: broad task first, then specific workflows, then advanced capabilities +- Optimize sidebar labels for first-time users who may not know Requestly terminology +- Follow familiar developer-doc patterns used by products like Postman or Stripe, where the first scan answers "what can I do?" before "which feature does this belong to?" +- When editing `docs.json`, prefer structures such as: + - `API Testing` -> sending requests, environments, assertions, automation + - `Debugging & Interception` -> inspect traffic, capture sessions, troubleshoot requests + - `Modify Traffic` -> modify headers, redirect requests, rewrite bodies, delay responses + - `Mock APIs & Responses` -> quick mocks, mock servers, reusable mock workflows diff --git a/README.md b/README.md index 4b9848e..7786408 100644 --- a/README.md +++ b/README.md @@ -19,15 +19,14 @@ ## 📖 About -This repository contains the official documentation for [Requestly](https://requestly.com) - a powerful tool for API Mocking, Testing, and Debugging. The documentation covers: +This repository contains the official documentation for [Requestly](https://requestly.com), organized around the main jobs users come to Requestly to do: -- **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 +- **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 ## 🚀 Getting Started @@ -62,16 +61,17 @@ The documentation will be available at `http://localhost:3000` ``` 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 +├── 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 diff --git a/docs.json b/docs.json index a4c27c0..3e93833 100644 --- a/docs.json +++ b/docs.json @@ -15,12 +15,6 @@ }, "favicon": "/images/favicon.webp", "navbar": { - "links": [ - { - "label": "Open App", - "href": "https://app.requestly.io/api-client?utm_source=docs&utm_medium=navbar&utm_campaign=get_started" - } - ], "primary": { "type": "button", "label": "Download", @@ -35,34 +29,11 @@ "groups": [ { "group": "Getting Started", - "pages": [ - "general/getting-started/introduction", - "general/getting-started/downloads", - { - "group": "Quick Start Guide", - "pages": [ - "general/getting-started/quick-start-guide", - "general/getting-started/quick-start-guide/browser-extension-setup", - "general/getting-started/quick-start-guide/desktop-app-setup" - ] - } - ] - }, - { - "group": "API Client", "pages": [ "general/api-client/overview", - { - "group": "Getting Started", - "pages": [ - "general/api-client/quick-start", - "general/api-client/difference-between-desktop-app-and-browser-extension" - ] - }, { "group": "Sending Requests", "pages": [ - "general/api-client/send-api-request/overview", { "group": "Create Requests", "pages": [ @@ -84,19 +55,19 @@ "pages": [ "general/api-client/design-apis", "general/api-client/api-collections", - "general/api-client/examples", - { - "group": "Import & Export APIs", - "pages": [ - "general/api-client/import-export", - "general/api-client/import-export/import-from-curl", - "general/api-client/import-export/import-from-wsdl", - "general/api-client/import-export/import-from-postman", - "general/api-client/import-export/import-openapi-spec", - "general/api-client/import-export/import-export-api-collections", - "general/api-client/import-export/import-export-api-environment" - ] - } + "general/api-client/examples" + ] + }, + { + "group": "Import & Export", + "pages": [ + "general/api-client/import-export", + "general/api-client/import-export/import-from-curl", + "general/api-client/import-export/import-from-postman", + "general/api-client/import-export/import-from-wsdl", + "general/api-client/import-export/import-openapi-spec", + "general/api-client/import-export/import-export-api-collections", + "general/api-client/import-export/import-export-api-environment" ] }, { @@ -113,33 +84,122 @@ ] }, { - "group": "Scripts & Tests", + "group": "API Testing", "pages": [ "general/api-client/scripts", - "general/api-client/ai-test-generator", - "general/api-client/import-packages-into-your-scripts", "general/api-client/tests", - { - "group": "API Reference (rq)", - "pages": [ - "general/api-client/rq-api-reference/rq-request", - "general/api-client/rq-api-reference/rq-response", - "general/api-client/rq-api-reference/rq-environment", - "general/api-client/rq-api-reference/rq-collection-variables", - "general/api-client/rq-api-reference/rq-globals", - "general/api-client/rq-api-reference/rq-test", - "general/api-client/rq-api-reference/rq-expect", - "general/api-client/rq-api-reference/rq-iteration-data", - "general/api-client/rq-api-reference/rq-info" - ] - }, - { - "group": "Collection Runner", - "pages": [ - "general/api-client/collection-runner", - "general/api-client/collection-runner-data-file" - ] - } + "general/api-client/ai-test-generator", + "general/api-client/import-packages-into-your-scripts" + ] + }, + { + "group": "Automation", + "pages": [ + "general/api-client/collection-runner", + "general/api-client/collection-runner-data-file" + ] + }, + { + "group": "API Reference", + "pages": [ + "general/api-client/rq-api-reference/rq-request", + "general/api-client/rq-api-reference/rq-response", + "general/api-client/rq-api-reference/rq-environment", + "general/api-client/rq-api-reference/rq-collection-variables", + "general/api-client/rq-api-reference/rq-globals", + "general/api-client/rq-api-reference/rq-test", + "general/api-client/rq-api-reference/rq-expect", + "general/api-client/rq-api-reference/rq-iteration-data", + "general/api-client/rq-api-reference/rq-info" + ] + } + ] + }, + { + "group": "Collaboration & Projects", + "pages": [ + "general/team/workspaces", + "general/team/local-workspace", + "general/team/multiple-workspaces", + { + "group": "Shared projects", + "pages": [ + "general/team/how-to-get-started-with-shared-workspace", + "general/team/how-to-get-started-with-shared-workspace/managing-workspace", + "general/team/how-to-get-started-with-shared-workspace/user-roles" + ] + } + ] + }, + { + "group": "Account & Administration", + "pages": [ + "general/others/billing-subscriptions", + "general/others/blocklist", + "general/others/how-is-bowser-extension-different-from-a-desktop-app", + { + "group": "Single Sign-On", + "pages": [ + "general/others/sso", + "general/others/sso/how-to-set-up-sso-with-microsoft-entra-id", + "general/others/sso/setup-sso-with-okta" + ] + } + ] + } + ] + }, + { + "tab": "HTTP Interception", + "icon": "globe", + "groups": [ + { + "group": "Getting Started", + "pages": [ + "general/getting-started/introduction", + "general/getting-started/quick-start-guide", + "general/getting-started/downloads", + "general/getting-started/quick-start-guide/browser-extension-setup", + "general/getting-started/quick-start-guide/desktop-app-setup", + "general/api-client/quick-start", + "general/api-client/difference-between-desktop-app-and-browser-extension" + ] + }, + { + "group": "Debugging & Interception", + "pages": [ + "general/http-interceptor/overview", + { + "group": "Capture Traffic", + "pages": [ + "general/http-interceptor/browser-extension", + "general/http-interceptor/browser-extension/browser-interception", + "general/http-interceptor/desktop-app", + "general/http-interceptor/desktop-app/browser-interception", + "general/http-interceptor/desktop-app/desktop-app-interception", + "general/http-interceptor/desktop-app/network-table", + "general/http-interceptor/desktop-app/saving-logs-to-local-file" + ] + }, + { + "group": "Intercept Different Devices & Runtimes", + "pages": [ + "general/http-interceptor/desktop-app/android-devices", + "general/http-interceptor/desktop-app/android-simulator-interception", + "general/http-interceptor/desktop-app/ios-devices-interception", + "general/http-interceptor/desktop-app/ios-simulator-interception", + "general/http-interceptor/desktop-app/nodejs", + "general/http-interceptor/desktop-app/terminal" + ] + }, + { + "group": "Record & Share Sessions", + "pages": [ + "general/sessions/overview", + "general/sessions/record-api-sessions", + "general/sessions/record-bug-reports", + "general/sessions/import-view-har-file", + "general/sessions/access-control-of-session" ] } ] @@ -149,7 +209,7 @@ "pages": [ "general/http-rules/overview", { - "group": "HTTP Rules", + "group": "Modify Requests & Responses", "pages": [ "general/http-rules/rule-types", "general/http-rules/rule-types/redirect-rule", @@ -167,7 +227,7 @@ ] }, { - "group": "Advanced Usage", + "group": "Advanced Traffic Rules", "pages": [ "general/http-rules/advanced-usage", "general/http-rules/advanced-usage/grouping", @@ -184,17 +244,12 @@ ] }, { - "group": "Sharing", + "group": "Share & Import Rules", "pages": [ "general/http-rules/sharing", "general/http-rules/sharing/share-in-workspace", "general/http-rules/sharing/shared-list", - "general/http-rules/sharing/download-rules" - ] - }, - { - "group": "Import Rules", - "pages": [ + "general/http-rules/sharing/download-rules", "general/imports/charles-proxy", "general/imports/header-editor", "general/imports/modheader", @@ -204,143 +259,82 @@ ] }, { - "group": "HTTP Interceptor", + "group": "Mock APIs & Responses", "pages": [ - "general/http-interceptor/overview", { - "group": "Browser Extension", + "group": "Quick Mocking", "pages": [ - "general/http-interceptor/browser-extension", - "general/http-interceptor/browser-extension/browser-interception" + "general/api-mocking/api-mocking", + "general/api-mocking/create-cloud-based-mocks", + "general/api-mocking/create-local-api-mocks" ] }, { - "group": "Desktop App", + "group": "Mock Server", "pages": [ - "general/http-interceptor/desktop-app", - "general/http-interceptor/desktop-app/android-devices", - "general/http-interceptor/desktop-app/android-simulator-interception", - "general/http-interceptor/desktop-app/browser-interception", - "general/http-interceptor/desktop-app/desktop-app-interception", - "general/http-interceptor/desktop-app/ios-devices-interception", - "general/http-interceptor/desktop-app/ios-simulator-interception", - "general/http-interceptor/desktop-app/network-table", - "general/http-interceptor/desktop-app/nodejs", - "general/http-interceptor/desktop-app/saving-logs-to-local-file", - "general/http-interceptor/desktop-app/terminal" + "general/mock-server/overview", + { + "group": "Create Mocks", + "pages": [ + "general/mock-server/create", + "general/mock-server/create/create-mock-api", + "general/mock-server/create/create-new-mock-file", + "general/mock-server/create/mock-collection" + ] + }, + "general/mock-server/test", + "general/mock-server/pre-configured-mocks", + "general/mock-server/templating-in-mocks", + "general/mock-server/import-and-export-mocks" ] } ] }, { - "group": "Api Mocking", - "pages": [ - "general/api-mocking/api-mocking", - "general/api-mocking/create-cloud-based-mocks", - "general/api-mocking/create-local-api-mocks" - ] - }, - { - "group": "Mock Server", + "group": "Guides", "pages": [ - "general/mock-server/overview", { - "group": "Create Mocks", + "group": "API Testing & Automation", "pages": [ - "general/mock-server/create", - "general/mock-server/create/create-mock-api", - "general/mock-server/create/create-new-mock-file", - "general/mock-server/create/mock-collection" + "guides/community-content/using-collection-runner-in-requestly", + "guides/community-content/variables-and-environments-in-requestly" ] }, - "general/mock-server/test", - "general/mock-server/pre-configured-mocks", - "general/mock-server/templating-in-mocks", - "general/mock-server/import-and-export-mocks" - ] - }, - { - "group": "Sessions", - "pages": [ - "general/sessions/overview", - "general/sessions/record-api-sessions", - "general/sessions/record-bug-reports", - "general/sessions/import-view-har-file", - "general/sessions/access-control-of-session" - ] - }, - { - "group": "Team", - "pages": [ - "general/team/workspaces", - "general/team/local-workspace", - "general/team/multiple-workspaces", { - "group": "Shared Workspace", + "group": "Traffic Modification & Mocking", "pages": [ - "general/team/how-to-get-started-with-shared-workspace", - "general/team/how-to-get-started-with-shared-workspace/managing-workspace", - "general/team/how-to-get-started-with-shared-workspace/user-roles" + "guides/record-and-mock-flaky-apis-in-bulk", + "guides/how-to-modify-cookies-using-requestly", + "guides/modify-http-headers-in-web-automation-using-requestly", + "guides/modify-html-document-using-modify-api-response-rule", + "guides/how-to-use-shared-state-to-aggregate-data-and-use-across-requestly-rules", + "guides/modifying-response-asynchronously", + "guides/how-to-conditionally-fail-requests-based-on-request-counts", + "guides/intercepting-and-modifying-network-requests-in-web-automation-frameworks-like-selenium-and-playwright" ] - } - ] - }, - { - "group": "Others", - "pages": [ - "general/others/billing-subscriptions", - "general/others/blocklist", - "general/others/how-is-bowser-extension-different-from-a-desktop-app", + }, { - "group": "SSO", + "group": "Debugging & Interception", "pages": [ - "general/others/sso", - "general/others/sso/how-to-set-up-sso-with-microsoft-entra-id", - "general/others/sso/setup-sso-with-okta" + "guides/how-to-avoid-intercepting-certain-domains-on-the-desktop-app", + "guides/how-to-use-requestly-extension-in-browserstack-live", + "guides/requestly-integration-browserstack-app-live", + "guides/disable-rule-application-status-widget", + "guides/disable-rules-syncing", + "guides/can-i-log-in-to-requestly-using-my-browserstack-account", + "guides/how-to-update-requestly-extension-manually" + ] + }, + { + "group": "Other", + "pages": [ + "guides/other/claim-your-requestly-github-student-pack-benefit" ] } ] - } - ] - }, - { - "tab": "Guides", - "icon": "lightbulb", - "groups": [ - { - "group": "Overview", - "pages": [ - "guides/how-to-modify-cookies-using-requestly", - "guides/modify-http-headers-in-web-automation-using-requestly", - "guides/modify-html-document-using-modify-api-response-rule", - "guides/how-to-use-shared-state-to-aggregate-data-and-use-across-requestly-rules", - "guides/intercepting-and-modifying-network-requests-in-web-automation-frameworks-like-selenium-and-playwright", - "guides/disable-rule-application-status-widget", - "guides/disable-rules-syncing", - "guides/modifying-response-asynchronously", - "guides/how-to-avoid-intercepting-certain-domains-on-the-desktop-app", - "guides/how-to-conditionally-fail-requests-based-on-request-counts", - "guides/how-to-use-requestly-extension-in-browserstack-live", - "guides/requestly-integration-browserstack-app-live", - "guides/record-and-mock-flaky-apis-in-bulk", - "guides/can-i-log-in-to-requestly-using-my-browserstack-account", - "guides/how-to-update-requestly-extension-manually" - ] }, { - "group": "Other", - "pages": [ - "guides/other/claim-your-requestly-github-student-pack-benefit" - ] - } - ] - }, - { - "tab": "Public APIs", - "icon": "code", - "groups": [ - { - "group": "Overview", + "group": "Public APIs", "pages": [ "public-apis/overview", "public-apis/create-group", @@ -352,39 +346,38 @@ "public-apis/delete-group", "public-apis/delete-rule" ] - } - ] - }, - { - "tab": "Troubleshoot", - "icon": "wrench", - "groups": [ - { - "group": "HTTP Interceptor", - "pages": [ - "troubleshoot/http-interceptor/unable-to-intercept-web-traffic-on-browser-mobile-or-emulator", - "troubleshoot/http-interceptor/intercepting-requests-from-localhost", - "troubleshoot/http-interceptor/system-wide-proxy-not-working-macos", - "troubleshoot/http-interceptor/troubleshooting-proxy-not-shown-windows", - "troubleshoot/http-interceptor/troubleshooting-untrusted-ssl-certificate", - "troubleshoot/http-interceptor/install-certificate-windows", - "troubleshoot/http-interceptor/troubleshooting-safari", - "troubleshoot/http-interceptor/disable-system-wide-proxy-macos" - ] }, { - "group": "HTTP Rules", + "group": "Troubleshoot", "pages": [ - "troubleshoot/http-rules/rules-not-working", - "troubleshoot/http-rules/error-on-saving-rule", - "troubleshoot/http-rules/rule-changes-not-reflecting-in-chrome-devtools" - ] - }, - { - "group": "Miscellaneous", - "pages": [ - "troubleshoot/miscellaneous/troubleshooting-login-issues", - "troubleshoot/miscellaneous/how-to-check-your-requestly-version-in-the-browser" + { + "group": "Interception Setup", + "pages": [ + "troubleshoot/http-interceptor/unable-to-intercept-web-traffic-on-browser-mobile-or-emulator", + "troubleshoot/http-interceptor/intercepting-requests-from-localhost", + "troubleshoot/http-interceptor/troubleshooting-untrusted-ssl-certificate", + "troubleshoot/http-interceptor/install-certificate-windows", + "troubleshoot/http-interceptor/system-wide-proxy-not-working-macos", + "troubleshoot/http-interceptor/troubleshooting-proxy-not-shown-windows", + "troubleshoot/http-interceptor/troubleshooting-safari", + "troubleshoot/http-interceptor/disable-system-wide-proxy-macos" + ] + }, + { + "group": "Rules & Traffic Modification", + "pages": [ + "troubleshoot/http-rules/rules-not-working", + "troubleshoot/http-rules/error-on-saving-rule", + "troubleshoot/http-rules/rule-changes-not-reflecting-in-chrome-devtools" + ] + }, + { + "group": "Account & Miscellaneous", + "pages": [ + "troubleshoot/miscellaneous/troubleshooting-login-issues", + "troubleshoot/miscellaneous/how-to-check-your-requestly-version-in-the-browser" + ] + } ] } ] @@ -550,7 +543,7 @@ "redirects": [ { "source": "/general/api-client/make-an-api-request", - "destination": "/general/api-client/send-api-request" + "destination": "/general/api-client/overview" }, { "source": "/general/api-client/migrate-from-postman", @@ -698,7 +691,7 @@ }, { "source": "/desktop-app/setup/connect-existing-browser-profile", - "destination": "http://localhost:3000/general/http-interceptor/desktop-app/browser-interception#connect-existing-browser-profile" + "destination": "/general/http-interceptor/desktop-app/browser-interception#connect-existing-browser-profile" }, { "source": "/desktop-app/setup/android", @@ -1000,9 +993,13 @@ "source": "/general/api-client/authorization", "destination": "/general/api-client/send-api-request/authorization" }, + { + "source": "/general/api-client/send-api-request/overview", + "destination": "/general/api-client/overview" + }, { "source": "/general/api-client/send-api-request", - "destination": "/general/api-client/send-api-request/overview" + "destination": "/general/api-client/overview" }, { "source": "/general/api-client/create-requests", diff --git a/general/api-client/design-apis.mdx b/general/api-client/design-apis.mdx index 460459b..2ddc907 100644 --- a/general/api-client/design-apis.mdx +++ b/general/api-client/design-apis.mdx @@ -17,7 +17,7 @@ The **API Builder** in Requestly helps you design APIs, manage them using collec * To start creating APIs, click the `+ New` button at the top left of the API Builder. This provides three options: - * **API Request**: [Create a new API request](/general/api-client/make-an-api-request). + * **API Request**: [Create a new API request](/general/api-client/overview). * **API Collection**: Organise multiple requests under [a collection](/general/api-client/api-collections). diff --git a/general/api-client/difference-between-desktop-app-and-browser-extension.mdx b/general/api-client/difference-between-desktop-app-and-browser-extension.mdx index 491b5da..32beca3 100644 --- a/general/api-client/difference-between-desktop-app-and-browser-extension.mdx +++ b/general/api-client/difference-between-desktop-app-and-browser-extension.mdx @@ -1,12 +1,12 @@ --- -title: Desktop App vs Browser Extension -label: Differences Between Desktop App and Browser Extension +title: Desktop App vs Web App +label: Desktop App vs Web App slug: difference-between-desktop-app-and-browser-extension description: >- - Compare Requestly Desktop App and Browser Extension features to choose the right platform for your API testing needs. -seoTitle: Requestly - Desktop App vs Browser Extension Comparison + Compare Requestly Desktop App and web app experiences to choose the right setup for your API testing needs. +seoTitle: Requestly - Desktop App vs Web App Comparison seoDescription: >- - Detailed comparison of Requestly Desktop App and Browser Extension for API testing. Learn which platform fits your workflow best. + Compare Requestly Desktop App and web app for API testing. Learn which setup fits your workflow best. visibility: PUBLIC --- @@ -14,10 +14,10 @@ visibility: PUBLIC ## Choose Your Platform -Requestly is available on **two platforms**, each with unique strengths: +Requestly is available in **two ways**, each with different strengths: - + **Best for:** Quick API testing, web development, lightweight workflows @@ -28,7 +28,7 @@ Requestly is available on **two platforms**, each with unique strengths: - **Can't decide?** Both platforms sync your collections and environments + **Can't decide?** Both experiences sync your collections and environments through Team Workspaces, so you can use whichever suits your current task. @@ -36,22 +36,22 @@ Requestly is available on **two platforms**, each with unique strengths: ## Feature Comparison -Use this table to compare capabilities and choose the right platform for your needs. +Use this table to compare capabilities and choose the right setup for your needs. ### Platform Availability -| Feature | Browser Extension | Desktop App | +| Feature | Web app | Desktop App | | ---------------------- | ------------------------------------------------- | --------------------- | | **Supported Browsers** | Chrome, Firefox, Edge, Brave, Arc, Vivaldi, Opera | N/A | | **Supported OS** | Any OS with supported browser | Windows, macOS, Linux | -| **Installation** | Chrome Web Store / Firefox. | Download installer | -| **Launch Speed** | Instant (already in browser) | Fast (standalone app) | +| **Installation** | Sign in from your browser | Download installer | +| **Launch Speed** | Fast (in browser) | Fast (standalone app) | --- ### API Testing Capabilities -| Feature | Browser Extension | Desktop App | +| Feature | Web app | Desktop App | | ----------------------------- | ---------------------------------------------------- | ---------------- | | **REST API Support** | ✅ Full support | ✅ Full support | | **GraphQL Support** | ✅ Full support | ✅ Full support | @@ -68,8 +68,8 @@ Use this table to compare capabilities and choose the right platform for your ne ### Organization & Workflow -| Feature | Browser Extension | Desktop App | -| -------------------------------- | ----------------- | ---------------- | +| Feature | Web app | Desktop App | +| -------------------------------- | ------- | ---------------- | | **API Collections** | ✅ Full support | ✅ Full support | | **Sub-collections / Folders** | ✅ Supported | ✅ Supported | | **Environment Variables** | ✅ Supported | ✅ Supported | @@ -86,8 +86,8 @@ Use this table to compare capabilities and choose the right platform for your ne ### Authentication & Security -| Feature | Browser Extension | Desktop App | -| ---------------------------- | ------------------ | ------------------- | +| Feature | Web app | Desktop App | +| ---------------------------- | -------- | ------------------- | | **API Key Auth** | ✅ Supported | ✅ Supported | | **Bearer Token** | ✅ Supported | ✅ Supported | | **Basic Auth** | ✅ Supported | ✅ Supported | @@ -96,8 +96,8 @@ Use this table to compare capabilities and choose the right platform for your ne ### Import & Export -| Feature | Browser Extension | Desktop App | -| ----------------------------- | ----------------- | ------------ | +| Feature | Web app | Desktop App | +| ----------------------------- | ------- | ------------ | | **Import from cURL** | ✅ Supported | ✅ Supported | | **Import from Postman** | ✅ Supported | ✅ Supported | | **Import OpenAPI/Swagger** | ✅ Supported | ✅ Supported | @@ -108,8 +108,8 @@ Use this table to compare capabilities and choose the right platform for your ne ### Collaboration & Workspaces -| Feature | Browser Extension | Desktop App | -| ---------------------- | ---------------------------------- | ---------------------------------- | +| Feature | Web app | Desktop App | +| ---------------------- | ------------------------ | ---------------------------------- | | **Local Workspace** | ❌ Not available | ✅ Supported | | **Team Workspaces** | ✅ Supported | ✅ Supported | @@ -118,17 +118,17 @@ Use this table to compare capabilities and choose the right platform for your ne ## Decision Guide - - ### Choose **Browser Extension** if you: + + ### Choose the **web app** if you: - ✅ Primarily test web APIs during frontend development - - ✅ Want zero-install, instant access in your browser + - ✅ Want fast access in your browser - ✅ Don't need file upload testing - ✅ Work mostly with JSON/text payloads - - ✅ Prefer a lightweight tool integrated with your browser + - ✅ Prefer a lightweight workflow in the browser - - Install from Chrome Web Store and start testing APIs instantly + + Open the docs homepage and follow Getting Started @@ -154,12 +154,12 @@ Use this table to compare capabilities and choose the right platform for your ne ## Can I Use Both? -**Absolutely!** Many users use both platforms: +**Absolutely!** Many people use both: -- **Browser Extension** for quick web API testing during development +- **Web app** for quick API testing during development - **Desktop App** for advanced testing, mobile debugging, and session recording -Your collections and environments sync across both platforms when you use Team Workspaces, giving you the flexibility to switch based on your current task. +Your collections and environments sync across both when you use Team Workspaces, giving you flexibility to switch based on your current task. --- @@ -167,27 +167,27 @@ Your collections and environments sync across both platforms when you use Team W - Learn more about the browser extension + Choose a path and set up Requestly - Explore desktop app capabilities + Install and configure the desktop app - Get started with API Client in 5 minutes + Get started with API Client in a few minutes diff --git a/general/api-client/examples.mdx b/general/api-client/examples.mdx index 400ca55..43ced1e 100644 --- a/general/api-client/examples.mdx +++ b/general/api-client/examples.mdx @@ -114,4 +114,4 @@ When viewing an example, click **Use as Template** to load its configuration int Add pre-request scripts and tests to automate your workflow - \ No newline at end of file + diff --git a/general/api-client/import-export/import-from-wsdl.mdx b/general/api-client/import-export/import-from-wsdl.mdx index 8bb9100..edcb1fc 100644 --- a/general/api-client/import-export/import-from-wsdl.mdx +++ b/general/api-client/import-export/import-from-wsdl.mdx @@ -6,7 +6,7 @@ A WSDL (Web Services Description Language) file defines the structure of a SOAP - Open App and click the `Import` button. + In Requestly, open **API Client** and click the `Import` button. ![Import WSDL](/images/ImportWSDL.png) diff --git a/general/api-client/overview.mdx b/general/api-client/overview.mdx index 73e5807..e9a8b1a 100644 --- a/general/api-client/overview.mdx +++ b/general/api-client/overview.mdx @@ -1,185 +1,157 @@ --- -title: API Client Overview +title: Overview label: Overview slug: overview description: >- - Build, test, and debug APIs with Requestly's powerful API Client. A modern, intuitive platform for API development, testing, and collaboration. + Learn when to use Requestly as your API client, how to send requests, get started fast, and which workflows to explore next. seoDescription: >- - Learn about Requestly - a comprehensive tool for designing, testing, and managing APIs with support for collections, environments, scripts, and team collaboration. + Learn how to use Requestly for API testing, sending HTTP requests, environments, collections, scripts, and assertions. +seoTitle: Requestly API client overview visibility: PUBLIC --- -*** +In Requestly, you can send requests, inspect responses, organize APIs, and automate API testing workflows. -## What is Requestly? +## When To Use Requestly -Requestly is a modern, browser-based and desktop tool for designing, testing, and debugging APIs. Whether you're a frontend developer testing endpoints, a backend engineer validating API contracts, or a QA professional running test suites, the API Client streamlines your entire API workflow. +Use Requestly when you want to: + +- send REST or GraphQL requests manually +- manage collections, folders, and reusable environments +- add authorization, scripts, and assertions +- run repeatable request flows and share them with your team + +If your goal is to inspect live traffic from an app or browser, start with [HTTP Interceptor](/general/http-interceptor/overview) instead. If you need to rewrite traffic in-place, use [HTTP Rules](/general/http-rules/overview). + +## What You Can Do Here - - Test any REST API or GraphQL endpoint with full support for all HTTP methods + + Test REST and GraphQL APIs with full request and response controls. - Group related APIs into collections for better project structure + Group related APIs into collections, folders, and reusable workflows. - Use environment and collection variables to switch contexts seamlessly + Switch between environments and reuse dynamic values safely. - Write pre-request and post-response scripts in JavaScript + Add scripts, assertions, and automation logic in JavaScript. -*** +## Sending requests -## Why Choose Requestly? +Whether you are building and testing your own API or integrating with a third-party API, you can use Requestly to send requests and connect to the APIs you are working with. Your requests can retrieve, create, update, or delete data, and they can include parameters and authorization details. - - - Works directly in your browser or desktop app with no complex setup required. Start testing APIs in seconds. - - - - Switch between development, staging, and production environments with a single click using environment variables. - - - - Never lose a request - access your complete request history and replay any previous API call instantly. - - - - Share collections, environments, and requests with your team through workspaces for seamless collaboration. - - - - Built-in support for API Key, Bearer Token and Basic Auth authentication methods. - - +For example, if you are building a client application such as a mobile or web app for a store, you might send one request to retrieve a list of available products, another request to create a new order with selected product details, and another request to log a customer into their account. -*** +When you send a request, Requestly displays the API server’s response in a clear format so you can inspect, visualize, and troubleshoot it easily. -## Core Features +![Send API Request Screenshot](/images/send-api-request/cb0bd862-28ab-4900-b501-2c25ec881e37.png) -### **Build & Test APIs** +### Get started with sending requests -Create and send HTTP requests with an intuitive interface. Configure methods, headers, query parameters, and request bodies with ease. +If you have not sent a request before, review [Sending your first request](/general/api-client/quick-start) before continuing. - - - Learn how to send your first API request and view responses - - - Test GraphQL APIs with query and mutation support - - +Explore the topics below to learn how to send API requests in Requestly: -### **Organize Your Workflow** +- To understand the basics of building requests, including selecting HTTP methods, entering URLs, and interpreting response status codes, see [Configure request](/general/api-client/send-api-request/create-requests/configure-request). -Keep your API projects organized with collections and smart grouping features. +- To learn how to add query parameters, path variables, and request body data in formats such as JSON, form data, and file uploads, see [Parameters and body data](/general/api-client/send-api-request/create-requests/parameters-and-body). - - - Group related requests into collections and sub-folders - - - Execute multiple requests sequentially for testing workflows - - +- If your API requires specific headers or authentication tokens, learn how to configure them in [Request headers](/general/api-client/send-api-request/create-requests/request-headers). -### **Dynamic Configuration** +- Export requests as code snippets in multiple languages such as JavaScript, Python, and cURL. Learn more in [Generate client code](/general/api-client/send-api-request/create-requests/generate-client-code). -Use variables and environments to make your API testing flexible and reusable across different contexts. - - - - Master environment, collection, and global variables - - - Switch between dev, staging, and production - - - Understand how variable scoping works - - - -### **Automate & Extend** - -Add custom logic to your API requests with scripts and automated testing. - - - - Run JavaScript before and after requests - - - Write automated tests for your API responses - - - Export requests as code in multiple languages - - +- If your API requires identity verification or access control, review the [authorization guide](/general/api-client/send-api-request/authorization). -### **Secure Your APIs** +- Use collections to group related requests for better organization and collaboration. Learn more in [API collections](/general/api-client/api-collections). -Configure authentication for protected endpoints with multiple auth methods. +- Variables allow you to reuse data across requests and switch values based on environments such as development, staging, or production. See [Variables and environments](/general/api-client/environments-and-variables). - - Set up API Key, Bearer Token, Basic Auth, and more - +- Add JavaScript code to run before sending requests or after receiving responses to automate workflows and extract data. Learn more in [Scripts](/general/api-client/scripts). -### **Import & Export** +- Write automated tests to validate API responses and ensure reliability. See [Tests](/general/api-client/tests). -Migrate from other tools or share your work with team members. +In addition to standard HTTP requests, Requestly also supports other formats and protocols such as [GraphQL](/general/api-client/send-api-request/graphql-request). You can also [import from cURL](/general/api-client/import-export/import-from-curl), [import from Postman](/general/api-client/import-export/import-from-postman), or [import OpenAPI specifications](/general/api-client/import-export/import-openapi-spec). - - - Convert cURL commands to requests instantly - - - Migrate your Postman collections seamlessly - - - Import OpenAPI/Swagger specifications - - - Export and share your API collections + + + Start by learning how to configure HTTP methods and URLs + + + Learn to add query params, path variables, and request body + + + Follow our complete quick start guide for beginners -*** +## What you need before you start -## Getting Started +- a browser or desktop access to Requestly +- an endpoint to test, such as `https://app.requestly.io/echo` +- optional credentials or tokens if your API requires authorization -Ready to start testing APIs? Follow these quick steps: +## First success path - - Use the [Browser Extension](/general/http-interceptor/browser-extension) or [Desktop App](/general/http-interceptor/desktop-app). See the [comparison guide](/general/api-client/difference-between-desktop-app-and-browser-extension) to help you decide. + + Open Requestly and create a new request. - - - Navigate to API Client → Click **+ New** → Select **Request** → Enter a URL and click **Send**. [View detailed guide →](/general/api-client/send-api-request) + + Start with the [quick start](/general/api-client/quick-start) to send a request and inspect the response. - - - Group related APIs into collections for better project management. [Learn more →](/general/api-client/api-collections) + + Move your requests into [collections](/general/api-client/api-collections) and set up [environments](/general/api-client/environments-and-variables) so you can reuse them across projects. - - - Set up environment variables to manage different API environments. [Configure environments →](/general/api-client/environments-and-variables) + + Add [authorization](/general/api-client/send-api-request/authorization), [scripts](/general/api-client/scripts), and [tests](/general/api-client/tests) to make the workflow repeatable. -*** +## Explore by workflow -## Next Steps - - - - New to API Client? Start here with our beginner-friendly guide + + + Follow the guided beginner walkthrough from first request to environments. + + + Learn request configuration, headers, body handling, authorization, and history. + + + Switch between dev, staging, and production without rewriting requests. + + + Add scripts, tests, and collection runs for repeatable API validation. + + + Bring work in from cURL, Postman, or OpenAPI and share collections back out. - - Learn how to send API requests and view responses + + Execute multi-request workflows against environments and test data. + + + +## Related capabilities + + + + Use HTTP Rules when you need to rewrite live requests and responses during testing. - - Organize your APIs into collections for better project management + + Use HTTP Interceptor when you need to inspect what your app is sending over the network. diff --git a/general/api-client/quick-start.mdx b/general/api-client/quick-start.mdx index 6b4b09f..fd097a9 100644 --- a/general/api-client/quick-start.mdx +++ b/general/api-client/quick-start.mdx @@ -14,12 +14,13 @@ Welcome to Requestly! This guide will help you get started in just a few minutes ## Prerequisites -You'll need either: -- **Browser Extension** ([Chrome](https://rqst.ly/chrome), Firefox, Edge, Brave) - Best for web API testing -- **Desktop App** ([Download](https://requestly.com/downloads/)) - Best for mobile apps, local APIs, and advanced use cases +You'll need access to Requestly in one of these ways: + +- **Web app** — open Requestly in a supported desktop browser for everyday API testing. +- **Desktop app** — [download](https://requestly.com/downloads/) for workflows that need file uploads, multipart forms, or deeper system integration. - Not sure which to use? Check out our [comparison guide](/general/api-client/difference-between-desktop-app-and-browser-extension) to help you decide. + Not sure which to use? See [Desktop app vs web app](/general/api-client/difference-between-desktop-app-and-browser-extension). *** diff --git a/general/api-client/send-api-request/overview.mdx b/general/api-client/send-api-request/overview.mdx deleted file mode 100644 index f304737..0000000 --- a/general/api-client/send-api-request/overview.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -title: "Overview" -label: "Overview" -slug: "overview" -description: "Learn how to create and send API requests in Requestly. Test APIs, configure requests, and view responses without writing code." -seoTitle: "Create API Requests in Requestly" -seoDescription: "Complete guide to creating API requests in Requestly. Send HTTP requests, configure parameters, headers, and body data for effective API testing." -visibility: "PUBLIC" ---- - -Whether you are building and testing your own API or integrating with a third-party API, you can use Requestly to send requests and connect to the APIs you are working with. Your requests can retrieve, create, update, or delete data, and they can include parameters and authorization details. - -For example, if you are building a client application such as a mobile or web app for a store, you might send one request to retrieve a list of available products, another request to create a new order with selected product details, and another request to log a customer into their account. - -When you send a request, Requestly displays the API server’s response in a clear format so you can inspect, visualize, and troubleshoot it easily. - -![Send API Request Screenshot](/images/send-api-request/cb0bd862-28ab-4900-b501-2c25ec881e37.png) - ---- - -## Get Started with Sending Requests - -If you have not sent a request before, review the [Sending Your First Request](/general/api-client/quick-start) guide before continuing. - -Explore the topics below to learn how to send API requests in Requestly: - -- To understand the basics of building requests, including selecting HTTP methods, entering URLs, and interpreting response status codes, see [Configure Request](/general/api-client/send-api-request/configure-request). - -- To learn how to add query parameters, path variables, and request body data in formats such as JSON, form data, and file uploads, see [Parameters and Body Data](/general/api-client/send-api-request/parameters-and-body). - -- If your API requires specific headers or authentication tokens, learn how to configure them in [Request Headers](/general/api-client/send-api-request/request-headers). - -- Export requests as code snippets in multiple languages such as JavaScript, Python, and cURL. Learn more in [Generate Client Code](/general/api-client/generate-client-code). - -- If your API requires identity verification or access control, review the [Authorization Guide](/general/api-client/authorization). - -- Use collections to group related requests for better organization and collaboration. Learn more in [API Collections](/general/api-client/api-collections). - -- Variables allow you to reuse data across requests and switch values based on environments such as development, staging, or production. See [Variables and Environments](/general/api-client/environments-and-variables). - -- Add JavaScript code to run before sending requests or after receiving responses to automate workflows and extract data. Learn more in [Scripts](/general/api-client/scripts). - -- Write automated tests to validate API responses and ensure reliability. See [Tests](/general/api-client/tests). - -- Export requests as code snippets in multiple languages such as JavaScript, Python, and cURL. Learn more in [Generate Client Code](/general/api-client/generate-client-code). - -In addition to standard HTTP requests, Requestly also supports other formats and protocols such as [GraphQL](/general/api-client/graphql-request). You can also [import from cURL](/general/api-client/import-export/import-from-curl), [migrate from Postman](/general/api-client/import-export/import-from-postman), or [import OpenAPI specifications](/general/api-client/import-export/import-openapi-spec). - ---- - -## What's Next? - - - - Start by learning how to configure HTTP methods and URLs - - - Learn to add query params, path variables, and request body - - - Follow our complete quick start guide for beginners - - diff --git a/general/api-mocking/create-cloud-based-mocks.mdx b/general/api-mocking/create-cloud-based-mocks.mdx index bbbc059..f5fdd9c 100644 --- a/general/api-mocking/create-cloud-based-mocks.mdx +++ b/general/api-mocking/create-cloud-based-mocks.mdx @@ -5,16 +5,16 @@ slug: create-cloud-based-mocks description: Learn how to create modify and manage mock files in requestly visibility: PUBLIC --- -Cloud-based mocks let you simulate API responses by hosting mock data online instead of running a local server. With Requestly’s File Server, you can upload mock files (like JSON or HTML) and redirect real API requests to these files. It’s a fast, shareable, and reliable way to mock backend APIs—perfect for frontend development or testing in isolation. +Cloud-based mocks let you simulate API responses by hosting mock data online instead of running a local server. With Requestly’s Mock Server, you can upload mock files like JSON or HTML and redirect real API requests to these files. It’s a fast, shareable, and reliable way to mock backend APIs for frontend development and testing in isolation. ## How to Create a Cloud-based Mock -To create a cloud mock, you’ll first create a file on the File Server and then set up a Redirect Rule to serve it in place of a real API. +To create a cloud mock, you’ll first create a file in Mock Server and then set up a Redirect Rule to serve it in place of a real API. -### Step 1: Create a File on Requestly’s File Server +### Step 1: Create a File in Requestly Mock Server - + From the Requestly Dashboard, go to the **Files** tab in the sidebar. @@ -47,7 +47,7 @@ To create a cloud mock, you’ll first create a file on the File Server and then -### Step 2: Redirect API Requests to the File Server +### Step 2: Redirect API Requests to Mock Server @@ -75,7 +75,7 @@ To create a cloud mock, you’ll first create a file on the File Server and then - Paste the File Server URL copied earlier. You can also select the file directly from your File Server. + Paste the Mock Server URL copied earlier. You can also select the file directly from Mock Server. diff --git a/general/getting-started/introduction.mdx b/general/getting-started/introduction.mdx index adb89f9..51a0455 100644 --- a/general/getting-started/introduction.mdx +++ b/general/getting-started/introduction.mdx @@ -2,133 +2,91 @@ title: "Introduction" label: "Introduction" slug: "introduction" -description: "Welcome to Requestly’s Documentation!" +description: "Start here to understand Requestly, choose the right workflow, and get to your first success quickly." visibility: "PUBLIC" --- - ---- - -Requestly is an open-source tool for API Mocking, Testing, and Debugging. It serves as a valuable companion for developers, offering the following features: - -- Send API requests using the API Client -- Create, manage, and collaborate on API contracts -- Override APIs by modifying headers, request bodies, response bodies, status codes, and adding delays -- Mock API responses -- Record Bug Reports - -This documentation provides official information on incorporating Requestly into your development workflows. - -Below is an introduction to each section of this documentation, allowing you to quickly navigate to the solution you need. - -## Getting Started - -If you are new to Requestly, We recommend you start with the [getting started](/general/getting-started/quick-start-guide) section. - -## API Client - -### Send API Request - -Use Requestly to send requests to the APIs you're working with. Learn more about [Send API requests and get response data](/general/api-client/make-an-api-request) in Requestly. - -### Design APIs - -Requestly supports designing APIs using its API Builder embedded into [API Client](/general/api-client/overview). Designing APIs in Requestly helps you streamline the rest of the development flow like testing, mocking, and debugging your APIs. - -Support of [collections](/general/api-client/api-collections), [environments](/general/api-client/environments-and-variables), and [scripts](/general/api-client/scripts) lets you design your API contracts quickly. Your API definition can serve as the single source of truth for your projects. Sharing APIs within or across teams is fast and easy. - -Start [designing your APIs in Requestly using API Builder](/general/api-client/make-an-api-request). - -### Develop APIs - -Use Requestly to help you during API development, learn how to use Requestly to speed up API Development. - -### Using Variables - -Use variables to control the variable parts of API Requests, such as the root URL, tokens, etc., that vary across environments. Learn more under [environment variables](/general/api-client/environments-and-variables). Requestly also supports collection-level variables for use within a collection. - -## HTTP Rules - -### Override APIs / Network Calls - -Requestly offers powerful HTTP Rules that enable you to modify network requests and responses effortlessly. You can override headers, edit the request body, customize the response body, or even change the response status code quickly. Additionally, you can modify query parameters to add, update, or delete parameters in a URL, and modify user-agent strings to simulate different devices or browsers. You can also cancel requests before they are executed. - -Explore [Modify Headers](/general/http-rules/rule-types/modify-headers), [Modify Query Parameters](/general/http-rules/rule-types/modify-query-params), [Modify User-Agent](/general/http-rules/rule-types/modify-user-agents), [Modify Request Body](/general/http-rules/rule-types/modify-request-body), [Modify API Response](/general/http-rules/rule-types/modify-response-body), and [Cancel Request](/general/http-rules/rule-types/cancel-rule) for step-by-step instructions and examples. - -### Redirect Network Calls/APIs - -Requestly provides two ways to redirect a network request, whether it is a script file, image, API, or any other resource. The [Redirect Rule](/general/http-rules/rule-types/redirect-rule) matches URL conditions and redirects all matching requests to a predefined URL. The [Replace Rule](/general/http-rules/rule-types/replace-strings) is more versatile, allowing you to match a URL, replace a part of it to create a new URL and redirect the request to this newly constructed URL. - -### Add Network Delay - -You can simulate network delays using the [Delay Rule](/general/http-rules/rule-types/delay-request), which allows you to add a delay (in milliseconds) to matching URLs. This is particularly helpful for testing your application's behavior under slow network conditions or during a slow process. - -### Insert Scripts - -The [Insert Scripts Rule](/general/http-rules/rule-types/modify-dominject-scripts) in Requestly enables you to make dynamic, on-the-fly changes to a webpage’s content or behavior without needing to access or modify the source code. - -## API Mocking - -API Mocking enables you to simulate APIs for testing and development without depending on live backend systems. Requestly supports two types of API Mocking: [Local Mocks](/general/http-rules/rule-types/modify-response-body), which can be created individually or in bulk by recording a live session for offline or quick testing, and [Cloud-Based Mocks](/general/mock-server/overview), which are hosted on Requestly’s platform for easy sharing and collaboration. - -## Team Collaboration - -Requestly makes teamwork seamless and efficient with [Team Workspaces](/general/others/workspaces). You can [add team members](/general/others/workspace/how-to-get-started-with-shared-workspace#adding-new-members), [assign specific roles](/general/others/workspace/user-roles), and manage [permissions](/general/others/workspace/user-roles#permissions-overview) through Role-Based Access Control (RBAC). This ensures that only authorized users can access or modify sensitive resources. Workspaces allow you to share HTTP Rules, saved sessions, API collections, environment variables, and mocks while maintaining security and control. With well-defined roles and permissions, Requestly helps you organize resources effectively and enables effortless collaboration without compromising access control. - -## Sessions - -Requestly’s **Sessions** feature provides powerful tools for capturing, analyzing, and sharing network activity. You can -record API sessions - -, replay them for testing, and even use them for bulk mocking. It also allows you to [record bug reports](/general/session-book/record-session), capturing screen activity, console logs, network logs, and environment details to create replicable bug reports for developers. - -Additionally, you can -import and view HAR files - -directly within Requestly for seamless analysis. To ensure security, sessions come with -access control options - -, allowing you to manage who can view or use the recorded sessions. - - - We do not record Request Headers because they often contain authentication and authorization information. - - -## Requestly Public API - -Requestly's [Public API](/public-apis/overview) enables seamless integration into your CI/CD pipelines, allowing you to programmatically manage HTTP rules for automated testing and deployments. With the API, you can add, update, delete, and retrieve rules, simplifying workflows like creating staging environments or updating configurations dynamically. - -## Imports - -Requestly's Imports feature lets you easily migrate configurations from tools like [Postman](/general/api-client/migrate-from-postman), [Charles Proxy](/general/http-rules/others/charles-proxy-importer), -Modheader - -, and -Resource Override - -, unifying your workflows within a single platform. - -## Security & Privacy - -At Requestly, we prioritize [security and privacy](/general/getting-started/security-privacy) across all aspects of our platform. Being -open source - -, our codebase is transparent and auditable. Our robust -infrastructure - -ensures reliable performance and data security, further backed by -SOC 2 compliance - -for industry-standard safeguards. Learn more about the security and privacy measures implemented for the -API Client - -, -HTTP Rules - -, -HTTP Interceptor - -, and [Session Book](/security-privacy/sessions) in our detailed documentation. - -## Billing - -Requestly's [Billing section](/general/others/billing-subscriptions) simplifies license and subscription management for teams. Through the Billing Team Dashboard, admins can assign or revoke licenses and manage roles like Billing Manager, Admin, and Member to streamline access and collaboration. \ No newline at end of file +Requestly helps you test APIs, intercept traffic, modify requests and responses, mock backend behavior, and share debugging context with your team. + +If you are new to Requestly, start by choosing the workflow that matches what you want to do first. + +## Choose Your Path + + + + Send your first request, organize collections, add environments, and validate responses. + + + Use the Browser Extension when you want to inspect and modify traffic in the browser. + + + Use the Desktop App when you need proxy-based interception for mobile apps, emulators, terminal tools, or system traffic. + + + Rewrite headers, bodies, query params, and responses without changing your application code. + + + Build reusable mock APIs and hosted responses for testing, demos, and collaboration. + + + Record bug reports, capture API sessions, import HAR files, and share findings with your team. + + + +## Understand The Product Areas + +### API Testing + +Use the [API Client](/general/api-client/overview) to send requests, organize collections, manage environments, write assertions, and automate test flows. + +### Debugging & Interception + +Use the [HTTP Interceptor](/general/http-interceptor/overview) when you need to inspect live traffic from a browser, desktop app, mobile device, emulator, terminal, or Node.js runtime. + +### Modify Traffic + +Use [HTTP Rules](/general/http-rules/overview) to modify headers, redirect requests, rewrite bodies, delay responses, inject scripts, or map requests to local and remote resources. + +### Mock APIs & Responses + +Use [API Mocking](/general/api-mocking/api-mocking) and [Mock Server](/general/mock-server/overview) to simulate backend behavior for development, testing, demos, and failure scenarios. + +### Collaboration & Sessions + +Use [Sessions](/general/sessions/overview) and [Workspaces](/general/team/workspaces) to capture debugging context, share reproducible artifacts, and collaborate across teams. + +## Recommended First Steps + + + + If you only need browser-based traffic tools, start with the Browser Extension. If you need to intercept mobile apps, emulators, localhost traffic, or system-wide traffic, use the Desktop App. + + + Use the [platform comparison guide](/general/api-client/difference-between-desktop-app-and-browser-extension) if you are not sure which setup to choose. + + + + Follow either the [Browser Extension setup](/general/getting-started/quick-start-guide/browser-extension-setup) or [Desktop App setup](/general/getting-started/quick-start-guide/desktop-app-setup) guide. + + + Pick one clear first task: + + - [Send your first API request](/general/api-client/quick-start) + - [Inspect live traffic](/general/http-interceptor/overview) + - [Create your first traffic rule](/general/http-rules/rule-types) + - [Create your first mock](/general/mock-server/create/create-mock-api) + + + +## Next Steps + + + + Follow the guided onboarding flow for the most common Requestly workflows. + + + Get help with certificate, localhost, proxy, and device interception issues. + + + Automate Requestly workflows programmatically. + + \ No newline at end of file diff --git a/general/getting-started/quick-start-guide.mdx b/general/getting-started/quick-start-guide.mdx index c633e1c..d670614 100644 --- a/general/getting-started/quick-start-guide.mdx +++ b/general/getting-started/quick-start-guide.mdx @@ -3,46 +3,91 @@ title: Quick Start label: Quick Start slug: quick-start-guide description: >- - Discover Requestly’s powerful tools for API development, traffic debugging, - and collaboration — from browser extensions to desktop apps and HTTP rules. + Choose the right Requestly workflow, complete setup, and get to your first successful task quickly. visibility: PUBLIC --- -*** +Requestly can support several workflows, but most new users only need one path to start. Use this page to pick the right setup and reach your first success faster. -## Learn More About Requestly Features - -Whether you're planning APIs, mocking endpoints, or debugging network traffic, Requestly simplifies every stage of API development. +## Pick Your Starting Workflow - - Learn how to navigate and use Requestly’s Browser Extension. Intercept & modify traffic directly inside your browser, available for Chrome, Firefox, Edge, Brave, Arc, Vivaldi, and Opera. + + Best for sending requests, working with collections, managing environments, and writing assertions. - - - Go beyond the browser with Requestly’s Desktop App. Intercept traffic from mobile apps, desktop software, and simulators. Mock local files, analyse HAR files, and record sessions — all from a single interface. + + Best for intercepting and modifying requests directly in supported browsers. - - - Modern web-based API client that runs in your browser and standalone desktop app. Send API requests, define contracts, organize collections, and test endpoints — all in one place. + + Best for mobile apps, emulators, localhost traffic, command-line tools, and system-wide debugging. - - - Create rules to modify requests/responses in real-time. Redirect URLs, replace content, inject scripts, cancel requests, and more all in your browser without touching any code. + + Best for modifying headers, redirecting URLs, rewriting responses, and simulating backend behavior. + - - Host your JSON, JS, or CSS files and get public URLs to use in testing and development. Ideal for mocking API responses or replacing scripts/styles into pages. - +## Which Setup Should You Choose? - - Inspect live network traffic from your browser, mobile device, or desktop app. Capture requests/responses with full headers and body content. - + + + Choose the Browser Extension when: - - Record sessions of your activity including network logs, console logs, local storage, screen recording, and environment details. Useful for sharing bug reports bug reports. - + - you only need browser-based workflows + - you want quick setup with no system proxy configuration + - you plan to inspect traffic, create rules, or use the API Client in the browser + + + Install the extension, understand the interface, and learn what it can do. + + + + Choose the Desktop App when: + + - you need to intercept mobile devices, emulators, or desktop apps + - you need system-wide or proxy-based interception + - you want richer network capture, HAR workflows, or advanced debugging - - Create shared collections, sync rules, and collaborate with your team. Perfect for managing test environments and large projects. + + Install the desktop app and connect the right runtime for your workflow. + + + + + + Still deciding? Read the [Browser Extension vs Desktop App comparison](/general/api-client/difference-between-desktop-app-and-browser-extension). + + +## Reach Your First Success + + + + Finish either the [Browser Extension setup](/general/getting-started/quick-start-guide/browser-extension-setup) or [Desktop App setup](/general/getting-started/quick-start-guide/desktop-app-setup). + + + Start with one clear outcome instead of exploring every feature at once. + + - [Send your first API request](/general/api-client/quick-start) + - [Inspect traffic with HTTP Interceptor](/general/http-interceptor/overview) + - [Create your first HTTP Rule](/general/http-rules/rule-types) + - [Create your first mock](/general/mock-server/create/create-mock-api) + + + After your first successful task, expand into environments, assertions, automation, sessions, and collaboration workflows. + + + +## Common Journeys + + + + Start with API Client if your immediate goal is testing an endpoint. + + + Start with HTTP Rules if you need to change traffic without updating application code. + + + Start with HTTP Interceptor if you need to see live network traffic and trace issues. + + + Start with Sessions if you need reproducible bug reports or sharable network captures. diff --git a/general/getting-started/quick-start-guide/browser-extension-setup.mdx b/general/getting-started/quick-start-guide/browser-extension-setup.mdx index 6afaf91..5273bba 100644 --- a/general/getting-started/quick-start-guide/browser-extension-setup.mdx +++ b/general/getting-started/quick-start-guide/browser-extension-setup.mdx @@ -54,10 +54,10 @@ The Web App can be accessed using the `Open App` button in the Extension Popup 2. **Network Inspector**: Similar to the browser’s dev tools, but with additional features. 3. **HTTP Rules**: Allows you to override network requests by modifying parts of the request or redirecting them—our most popular feature. 4. **Sessions**: Contains saved sessions from the Extension Popup discussed earlier. -5. **File Server**: Allows you to host custom files (JSON, JS, CSS) in the cloud and generate shareable endpoints. +5. **Mock Server**: Allows you to host custom files and mock endpoints in the cloud so you can test APIs and resource overrides with shareable URLs. 6. **API Client**: Offers an intuitive interface to create, manage, and call APIs. -Each section is explained in detail in its respective documentation. Visit Network Inspector, HTTP Rules, Sessions, File Server, and API Client for a deeper dive. +Each section is explained in detail in its respective documentation. Visit Network Inspector, HTTP Rules, Sessions, Mock Server, and API Client for a deeper dive. + + Start with API Testing if you want a quick first success. + + + Learn how interception works inside the browser extension. + + + Modify headers, redirect URLs, or rewrite responses without changing application code. + + + Check common extension and rules issues if traffic changes are not applying. + + \ No newline at end of file diff --git a/general/getting-started/quick-start-guide/desktop-app-setup.mdx b/general/getting-started/quick-start-guide/desktop-app-setup.mdx index 678cfc2..e44e3c5 100644 --- a/general/getting-started/quick-start-guide/desktop-app-setup.mdx +++ b/general/getting-started/quick-start-guide/desktop-app-setup.mdx @@ -43,3 +43,31 @@ The Desktop App interface closely mirrors the Web App interface, maintaining a c The Desktop App’s additional capabilities make it ideal for scenarios requiring non-browser traffic interception and advanced mocking. + +## When To Use The Desktop App + +Use the Desktop App when you want to: + +- intercept traffic from mobile apps, emulators, desktop apps, terminal tools, or Node.js +- capture system-wide traffic through a local proxy +- work with localhost traffic and advanced debugging scenarios +- record API sessions, import HAR files, or create mocks from captured traffic + +If you only need browser-based interception and a lighter setup, start with the [Browser Extension setup](/general/getting-started/quick-start-guide/browser-extension-setup). + +## Recommended Next Steps + + + + Learn how Requestly interception works across browsers, devices, and runtimes. + + + Record requests and responses you can analyze, replay, or share. + + + Use captured traffic to modify, replay, or mock backend behavior. + + + Follow the interception troubleshooting path if setup is complete but traffic is missing. + + diff --git a/general/http-interceptor/overview.mdx b/general/http-interceptor/overview.mdx index 905c530..7a4e3d6 100644 --- a/general/http-interceptor/overview.mdx +++ b/general/http-interceptor/overview.mdx @@ -3,86 +3,85 @@ title: Overview label: Overview slug: overview description: >- - Learn how to use Requestly’s HTTP Interceptor to debug, analyze, and modify - HTTP requests in real-time. Configure it for browsers, mobile, Node.js, and - systemwide setups. + Learn when to use HTTP Interceptor, choose the right interception setup, and debug traffic across browsers, devices, and runtimes. seoDescription: >- - Debug HTTP requests in real-time with Requestly's HTTP Interceptor. Configure - it for browsers, mobile, Node.js, and system-wide setups. + Debug HTTP traffic in real time with Requestly HTTP Interceptor for browsers, mobile devices, emulators, Node.js, terminal tools, and system-wide setups. visibility: PUBLIC --- -*** +HTTP Interceptor helps you inspect and debug real network traffic. Use it when you need to see what your browser, app, device, or runtime is actually sending and receiving. -Whether you’re a developer, QA engineer, or anyone working with HTTP requests and APIs, Requestly can help you intercept and analyze network traffic in real-time. This makes debugging issues or testing changes easier without touching the code. +## When To Use HTTP Interceptor -## How does Requestly Interceptor work? +Use HTTP Interceptor when you want to: -Requestly HTTP interceptor is a web proxy that runs on your computer. By routing network requests through Requestly, you can intercept all the network traffic made by the browser or your application. +- inspect requests and responses in real time +- debug browser, mobile, emulator, terminal, or Node.js traffic +- verify whether an issue is in the client, proxy, or backend +- capture traffic for sessions, HAR analysis, or later mocking -Reading and modifying any web request and response opens up a world of possibilities for debugging and analyzing your application. You can: +If you already know exactly how you want to change traffic, go to [HTTP Rules](/general/http-rules/overview). If you want to test APIs manually, start with [API Client](/general/api-client/overview). -* **Pinpoint Issues**: Identify network errors, slow responses, or missing resources. +## Choose Your Interception Setup -* **Test Edge Cases**: Simulate server errors or unexpected payloads. - -* **Inject Mock Data**: Replace live responses with custom data. - -* **Optimize APIs**: Refine requests to enhance performance. - -## Ways to intercept HTTP traffic - -Requestly offers two flexible ways to intercept HTTP traffic depending on your workflow and use case: - -### 1. **Browser extension** - -The **Requestly browser extension** lets you intercept and modify HTTP traffic directly inside your browser—perfect for front-end development and quick debugging. - -* **Best for**: Intercepting and modifying traffic in the browser - -* **Works across**: Web pages, browser-based applications - -Learn how to set up interceptor in browser extension. - -### 2. **Desktop app** - -The **Requestly Desktop App** runs a local proxy server that intercepts HTTP(S) traffic from any source, not just the browser. It’s designed for more advanced and system-wide debugging needs. - -* **Best for**: Advanced use cases, mobile and backend debugging - -* **Works across:** Browsers, mobile devices, emulators, terminal, Node.js, and system-wide applications - -**Platform-specific setup guides:** - -* [Browser Interception](/general/http-interceptor/desktop-app/browser-interception) - Configure Requestly with popular web browsers like Chrome, Firefox, Edge, etc - -* [Android devices](/general/http-interceptor/desktop-app/android-devices) - Intercept Traffic from your Android smartphones and tablets[.](/general/http-interceptor/browser-interception) - -* [Android emulator](/general/http-interceptor/desktop-app/android-simulator-interception) - Configure Android emulators in Android Studio. - -* [iOS Devices](/general/http-interceptor/desktop-app/ios-devices-interception) - Set up your iPhones and iPads to intercept their traffic - -* [iOS Emulator](/general/http-interceptor/desktop-app/ios-simulator-interception) - Use Requestly with iOS simulators in Xcode. - -* [Node.js](/general/http-interceptor/desktop-app/nodejs) - Integrate Requestly with Node.js applications to debug server-side network requests and responses during development or testing - -* [Terminal](/general/http-interceptor/desktop-app/terminal) - Use Requestly with command-line tools or scripts to intercept and manipulate HTTP requests for automation and debugging. - -* [Systemwide proxy](/general/http-interceptor/desktop-app/desktop-app-interception) - Configure Requestly as a systemwide proxy to capture and manipulate traffic across all applications and devices connected to your network. - -Once interception is set up, you can explore and debug traffic in the [**network table**](/general/http-interceptor/network-table), [export HAR files](/general/sessions/import-view-har-file), [save sessions](/general/sessions/record-api-sessions), and [create rules](/general/http-rules/rule-types) to simulate responses or rewrite requests in real-time. + + + Best for browser-only workflows and the fastest setup. + + + Best for mobile apps, emulators, localhost, terminal tools, Node.js, and system-wide traffic. + + -*** +## First Success Path + + + + Use the Browser Extension for browser-based traffic. Use the Desktop App when you need proxy-based interception outside the browser. + + + Follow one setup path and make sure the browser, device, or runtime is correctly connected to Requestly. + + + Open the [network table](/general/http-interceptor/desktop-app/network-table) or browser interception view and verify requests appear before moving on to rules or mocks. + + + +## Explore By Runtime + + + + Connect Chrome, Firefox, Edge, and similar browsers through the Desktop App. + + + Intercept traffic from Android phones and tablets. + + + Capture traffic from Android Studio emulators. + + + Set up iPhones, iPads, and iOS simulators. + + + Debug server-side requests from Node.js applications. + + + Inspect cURL, scripts, and other command-line network activity. + + -## What's Next? +## After Traffic Starts Flowing - - - Start intercepting traffic in your browser + + + Modify intercepted traffic once you know what needs to change. + + + Save traffic and debugging context for sharing, replaying, or mock creation. - - Set up system-wide interception with the desktop app + + Analyze previously captured network data inside Requestly. - - Learn how to modify intercepted requests and responses + + Use the troubleshooting path for certificate, localhost, proxy, or device issues. diff --git a/general/http-rules/overview.mdx b/general/http-rules/overview.mdx index 4b0cbc4..1dd7442 100644 --- a/general/http-rules/overview.mdx +++ b/general/http-rules/overview.mdx @@ -3,132 +3,81 @@ title: Overview label: Overview slug: overview description: >- - Learn how to customize HTTP requests, test traffic, and collaborate in - workspaces with Requestly's powerful HTTP rules and advanced features. + Learn when to use HTTP Rules, how to create your first rule, and which traffic modification workflows to explore next. seoTitle: Overview seoDescription: >- - Learn how to customize HTTP requests, test traffic, and collaborate in - workspaces with Requestly's powerful HTTP rules and advanced features. + Learn how to use Requestly HTTP Rules to modify headers, redirect URLs, rewrite bodies, delay responses, and share rules. visibility: PUBLIC --- -*** +HTTP Rules are the fastest way to change traffic without changing your app. Use them to modify headers, rewrite request or response bodies, redirect calls, inject scripts, delay traffic, or map requests to local and remote resources. -Requestly's HTTP Rules offer a powerful suite of tools to customize, test, and manage HTTP(S) traffic. Whether you're a developer, tester, or QA professional, these rules provide an easy way to manipulate requests and responses. Below, you'll find an introduction to each HTTP Rule with links to detailed guides. +## When To Use HTTP Rules -## HTTP Rules +Use HTTP Rules when you want to: -### Modify Request Body +- modify headers, query params, bodies, or user agents +- redirect requests between environments +- simulate errors, delays, and edge cases +- inject scripts or override resources during frontend testing +- create repeatable traffic changes for demos, debugging, and QA -Adjust outgoing API request payloads to meet testing and development requirements. Add static or dynamic data to refine request structures. See details in the [Modify Request Body guide](/general/http-rules/rule-types/modify-request-body). +If your goal is to inspect live traffic first, use [HTTP Interceptor](/general/http-interceptor/overview). If you need hosted mock endpoints, use [Mock Server](/general/mock-server/overview). -### Modify API Response +## Start With These Rule Types -Simulate API responses to test scenarios and edge cases. Use static data or dynamic transformations to validate application behavior. Learn more in the [Modify API Response guide](/general/http-rules/rule-types/modify-response-body). - -### Modify Headers - -Add, remove, or modify HTTP headers for debugging and control. Get started with the [Modify Headers guide](/general/http-rules/rule-types/modify-headers). - -### Cancel Request Rule - -Block specific network calls or simulate failure scenarios. Explore capabilities in the [Cancel Request Rule guide](/general/http-rules/rule-types/cancel-rule). - -### Modify Query Params - -Add, remove, or modify query parameters to refine API requests. Learn more in the [Modify Query Params guide](/general/http-rules/rule-types/modify-query-params). - -### Modify User Agents - -Test different browser and device environments by customizing User-Agent headers. Check out the [Modify User Agents guide](/general/http-rules/rule-types/modify-user-agents). - -### Redirect Request - -Redirect requests to different URLs to switch environments or resources during development. The Redirect Request guide provides details. - -### Replace String Rule - -Modify URLs or paths by replacing specific substrings. Learn more in the [Replace String Rule guide](/general/http-rules/rule-types/replace-strings). - -### Insert Script - -Inject JavaScript or CSS into web pages for advanced customization. Get started with the [Insert Script guide](/general/http-rules/rule-types/insert-scripts). - -### Delay Network Requests - -Simulate real-world network latencies by introducing delays. Configure delays using the [Delay Network Requests guide](/general/http-rules/rule-types/delay-network-requests). - -### Map Local - -Serve files from your local environment to test offline changes. Start mapping files in the [Map Local guide](/general/http-rules/rule-types/map-local). - -### Map Remote - -Redirect requests to different servers or environments for advanced testing. Learn how in the [Map Remote guide](/general/http-rules/rule-types/map-remote). - -*** - -## Advanced Options - -### Rules Grouping - -Organize related rules into groups for better clarity and management. Learn more in the [Rules Grouping guide](/general/http-rules/advanced-usage/grouping). - -### Rules Pinning - -Pinning rules in Requestly lets you quickly access and manage your rules from the Chrome toolbar, streamlining your workflow. Easily toggle rules on or off without opening the app. Learn more in the Pinning Rules guide - -### Source Conditions - -Source conditions in Requestly allow you to define criteria for matching network requests, enabling precise rule application. These criteria include URL, host, or path matching, supporting advanced filters like resource type and HTTP methods. Learn more in the [Source Conditions guide](/general/http-rules/advanced-usage/source-conditions). - -### GraphQL Support - -Modify GraphQL requests and responses for flexible API interactions. Check out the [GraphQL Support guide](/general/http-rules/advanced-usage/graphql-modify-request-response). - -### Test this Rule - -**Test This Rule** feature in the HTTP Rules section lets you validate rule configurations in real-time by applying them to a specific webpage or endpoint. Learn more in the [Test This Rule guide](/general/http-rules/advanced-usage/test-rules). - -### Shared State - -Enable advanced workflows by sharing data between rules. Learn more in the [Shared State guide](/general/http-rules/advanced-usage/shared-state). - -### Pause/Resume Requestly - -Pause and Resume in Requestly lets you temporarily disable its functionality to test your website's original behavior without interference. Learn more in the [Pause and Resume guide](/general/http-rules/advanced-usage/pauseresume-requestly). - -### Rules Status Syncing - -Rules status syncing ensures consistent rule statuses across shared workspaces, automatically applying changes made by any member. Ideal for teams with non-technical roles, it guarantees universal configurations. Learn more in the [Rules Status Syncing guide](/general/http-rules/advanced-usage/rules-status-syncing). - -*** - -## Rule Sharing - -### Share in Workspace - -Share in Workspace feature allows you to easily share HTTP rules within workspaces, promoting real-time collaboration and consistency among team members. Learn more in the [Share in Workspace guide](/general/http-rules/sharing/share-in-workspace). - -### SharedList - -Distribute rule collections for use across teams or environments. Learn more in the [SharedList guide](/general/http-rules/sharing/shared-list). - -### Download - -Export rules for offline use or transfer between systems. Find out how in the [Download guide](/general/http-rules/sharing/download-rules). + + + Add, remove, or overwrite headers for debugging and API testing. + + + Switch requests between environments or alternate resources instantly. + + + Simulate backend changes, mock responses, and reproduce edge cases. + + + Reproduce slow networks and performance-related issues. + + -*** +## First Success Path + + + + Start with a single change such as [Modify Headers](/general/http-rules/rule-types/modify-headers) or [Redirect Rule](/general/http-rules/rule-types/redirect-rule). + + + Use URL and source conditions to target only the traffic you want to change. + + + Use [Test This Rule](/general/http-rules/advanced-usage/test-rules), app behavior, or your API workflow to confirm the traffic changed as expected. + + + +## Explore By Workflow + + + + Browse the full catalog of traffic modification capabilities. + + + Learn grouping, source conditions, testing, shared state, and filters. + + + Share, sync, and distribute rules with your team or workspace. + + + Migrate rule configurations from other tools and extensions. + + -## What's Next? +## Related Capabilities - - - Explore all available rule types and create your first modification - - - Start by learning how to modify HTTP headers + + + Use HTTP Interceptor when you need to see requests and responses before deciding what to modify. - - Collaborate by sharing rules with your team members + + Use Mock Server when you need reusable mock endpoints instead of in-place traffic overrides. diff --git a/general/mock-server/create.mdx b/general/mock-server/create.mdx index 06991d7..aa24180 100644 --- a/general/mock-server/create.mdx +++ b/general/mock-server/create.mdx @@ -2,10 +2,10 @@ title: Create label: Create slug: create -description: 'Learn how to use File Server in requestly ' +description: 'Learn how to create and organize files and endpoints in Mock Server.' visibility: PUBLIC --- -File Server lets you upload JSON, CSS, and JS files and use them in your application to test features, serve APIs, or override assets, without touching production code. +Mock Server lets you upload JSON, CSS, and JS files and use them in your application to test features, serve APIs, or override assets without touching production code. @@ -17,6 +17,6 @@ File Server lets you upload JSON, CSS, and JS files and use them in your applica - Group related files into Collections to keep your File Server organized. The folder structure you create inside a collection is reflected in the file URLs + Group related files into collections to keep Mock Server organized. The folder structure you create inside a collection is reflected in the file URLs. diff --git a/general/mock-server/import-and-export-mocks.mdx b/general/mock-server/import-and-export-mocks.mdx index 0d43714..41c51d9 100644 --- a/general/mock-server/import-and-export-mocks.mdx +++ b/general/mock-server/import-and-export-mocks.mdx @@ -4,19 +4,19 @@ label: Import and Export Files slug: import-and-export-mocks visibility: PUBLIC --- -Requestly makes it easy to import and export File Server files as JSON. This helps you share, back up, or reuse mocks across different projects with just a few clicks. +Requestly makes it easy to import and export Mock Server files as JSON. This helps you share, back up, or reuse mocks across different projects with just a few clicks. ### Steps to Import Files: - Go to [File Server](https://app.requestly.io/mock-server/apis). Under the JSON Files section, click on the Import button. + Go to [Mock Server](https://app.requestly.io/mock-server/apis). Under the JSON Files section, click on the Import button. - Select the JSON file containing the files you want to import. Review the list, then click **Import** to add them to your File Server. + Select the JSON file containing the files you want to import. Review the list, then click **Import** to add them to Mock Server. @@ -24,7 +24,7 @@ Requestly makes it easy to import and export File Server files as JSON. This hel - Use the checkboxes to select the files you want to export from the File Server. + Use the checkboxes to select the files you want to export from Mock Server. diff --git a/general/mock-server/overview.mdx b/general/mock-server/overview.mdx index 65d48ba..145c5b9 100644 --- a/general/mock-server/overview.mdx +++ b/general/mock-server/overview.mdx @@ -2,32 +2,57 @@ title: Overview label: Overview slug: overview +description: "Learn when to use Mock Server, how it differs from in-place traffic modification, and how to create your first hosted mock." visibility: PUBLIC --- -Requestly’s **File Server** lets you upload and serve files (like JSON, JS, CSS, images, etc.) over a secure URL—perfect for local development and testing. +Requestly Mock Server lets you host reusable mock endpoints and static assets for testing, demos, and development workflows. -**Use Cases of File Server** +You may still see older references to "File Server" in parts of the product. In the docs, this capability is documented as **Mock Server** because its main value is helping you simulate APIs and serve mock resources. -* Host a JSON file and use it as an API endpoint +## When To Use Mock Server -* Redirect live CSS files to your styles hosted on the File Server +Use Mock Server when you want to: -* Replace production JavaScript with development versions to test new features safely +- create hosted mock APIs for frontend or QA work +- serve JSON, JavaScript, CSS, images, or other test assets over a public URL +- share reusable mocks with teammates +- combine hosted mocks with [HTTP Rules](/general/http-rules/overview) to redirect live requests to mock endpoints -You can use files hosted on the File Server with the [**Redirect Rule**](/general/http-rules/rule-types/redirect-rule) to map live network requests to your hosted files, making it easy to simulate APIs or override resources without changing the actual code. +If you only need to change traffic inside your current browser or app session, [HTTP Rules](/general/http-rules/overview) may be faster. If you need a quick local response override, [API Mocking](/general/api-mocking/api-mocking) may be a better fit. -*** +## First Success Path -## What's Next? + + + Start with [Create Mock API](/general/mock-server/create/create-mock-api) to define an endpoint and response. + + + Verify the response using [Test Mock APIs](/general/mock-server/test) or your preferred client. + + + Use the mock directly, or pair it with [Redirect Rule](/general/http-rules/rule-types/redirect-rule) to switch traffic to your hosted mock. + + - +## Explore By Workflow + + - Learn how to create and configure mock APIs + Build and publish your first mock endpoint. - Test your mocks before integrating them + Validate responses before connecting apps or teammates. - Add dynamic responses with templating + Add dynamic values and richer mock behavior. + + + Move mocks between workflows and share them more easily. + + + Start with local or cloud-based quick mocks when you do not need a full hosted mock server. + + + Route live requests to your mock endpoint without changing application code. diff --git a/general/mock-server/test.mdx b/general/mock-server/test.mdx index 54b5ce3..c0ee297 100644 --- a/general/mock-server/test.mdx +++ b/general/mock-server/test.mdx @@ -1,10 +1,10 @@ --- -title: Test File Server -label: Test File Server +title: Test Mock Server +label: Test Mock Server slug: test visibility: PUBLIC --- -After saving a file to the File Server, you can test it directly in Requestly’s API Client to verify that the response matches your expectations. +After saving a file or mock in Mock Server, you can test it directly in Requestly’s API Client to verify that the response matches your expectations. diff --git a/general/sessions/access-control-of-session.mdx b/general/sessions/access-control-of-session.mdx index e1197b5..0f9912a 100644 --- a/general/sessions/access-control-of-session.mdx +++ b/general/sessions/access-control-of-session.mdx @@ -3,17 +3,17 @@ title: Access Control of Session label: Access Control of Session slug: access-control-of-session description: >- - Learn how to manage access control for Session Book in Requestly, with options + Learn how to manage access control for Sessions in Requestly, with options for private, shared, and specific access, ensuring secure collaboration seoTitle: Access Control of Session seoDescription: >- - Learn how to manage access control for Session Book in Requestly, with options + Learn how to manage access control for Sessions in Requestly, with options for private, shared, and specific access, ensuring secure collaboration visibility: PUBLIC --- *** -Once you get familiar with SessionBook, you can dive into managing access control for session recordings. Requestly offers flexible **Access Control**, allowing you to decide who can view, delete, and share recorded sessions. These options ensure that your recordings are shared securely with the right people, giving you full control over who has access based on your team's needs. +Once you get familiar with Sessions, you can dive into managing access control for session recordings. Requestly offers flexible **Access Control**, allowing you to decide who can view, delete, and share recorded sessions. These options ensure that your recordings are shared securely with the right people, giving you full control over who has access based on your team's needs. ## **Sharing Options for Recordings** diff --git a/general/sessions/overview.mdx b/general/sessions/overview.mdx index f1f9e61..2277b5f 100644 --- a/general/sessions/overview.mdx +++ b/general/sessions/overview.mdx @@ -3,47 +3,76 @@ title: Overview label: Overview slug: overview description: >- - Learn how to use Session Book to record debug sessions, capture videos and - logs, and securely share them with your team. Streamline collaboration and - resolve issues faster + Learn when to use Sessions, how to record bug reports or API sessions, and how to share debugging context with your team. seoDescription: >- - Record, share, & debug faster with Session Book. Capture videos & logs of - debug sessions, then securely share with your team. + Record bug reports, capture API sessions, import HAR files, and share debugging context with Requestly Sessions. visibility: PUBLIC --- -*** +Sessions help you capture the evidence around a problem so it is easier to debug, replay, share, or turn into a mock later. -Sessions provide a structured way to record, analyze, and debug user interactions and network activity. Session Book helps QA teams and customer support professionals document issues during testing and support. On the other hand, capturing API sessions is essential for developers to effectively debug, resolve issues & create bulk mocks. +## When To Use Sessions -Requestly supports session creation through two primary methods: +Use Sessions when you want to: -* Browser Extension’s **Session Book** for **recording bug reports****.** +- record browser activity, console logs, network logs, and environment context for bug reports +- capture API traffic from the Desktop App for replay, analysis, or bulk mocking +- import HAR files for investigation +- share reproducible debugging context with teammates -* Desktop App for **capturing API sessions**. +You may still encounter older references to **Session Book** in the product or legacy links. In the docs, this workflow is documented under **Sessions**. -*** +## Choose The Right Session Workflow -### Record Bug Reports with Session Book + + + Use this path when you want browser-focused debugging context such as screen activity, console logs, network logs, and environment details. -The Session Book in Requestly streamlines bug reporting by enabling developers to record user interactions, network logs, console logs, environment details, and changes in local storage. While it supports manual recording, you can configure it for automatic recording of user activity. This ensures developers have the context needed to reproduce and resolve issues effectively. Sessions can be shared securely, offering flexible options such as private access, link sharing, or restricted visibility. + + Capture reproducible bug reports directly from the browser workflow. + + + + Use this path when you want to record API traffic from the Desktop App, inspect requests and responses, or create mocks from captured traffic. -*** + + Record and analyze network traffic from interception workflows. + + + -### Create API Sessions in Requestly +## First Success Path -Requestly’s Desktop App allows developers to capture and analyze API sessions through methods like the HTTP Interceptor, HAR file import, and .rqly file import. These sessions can be shared with teams by exporting and importing HAR files, making it easy to collaborate, debug issues, and streamline workflows. -*** + + + Start with browser bug reports if you need user-facing reproduction context. Start with API sessions if the problem is primarily network behavior. + + + Use [Record Bug Reports](/general/sessions/record-bug-reports) or [Record API Sessions](/general/sessions/record-api-sessions) depending on the workflow. + + + Share the session, import/export HAR files, or use captured traffic to support mocking and debugging flows. + + -## What's Next? +## Explore Sessions - + - Start recording user sessions to capture bugs effectively + Capture browser activity and rich debugging context for issue reproduction. - Record and replay API interactions for debugging + Record and analyze traffic captured from Requestly interception workflows. - Analyze existing HAR files in Requestly + Open and analyze existing HAR files in Requestly. + + + Control who can view and use shared sessions. + + + Start with HTTP Interceptor if you need to capture traffic before recording a reusable session. + + + Use captured sessions to create repeatable mocking workflows. \ No newline at end of file diff --git a/general/sessions/record-api-sessions.mdx b/general/sessions/record-api-sessions.mdx index 6ef6867..833f2d7 100644 --- a/general/sessions/record-api-sessions.mdx +++ b/general/sessions/record-api-sessions.mdx @@ -80,7 +80,7 @@ Follow these steps: ### Import a .rqly File -Requestly also supports importing its proprietary `.rqly` file format. This is useful for loading sessions captured from the Session Book. +Requestly also supports importing its proprietary `.rqly` file format. This is useful for loading sessions captured from browser-based Sessions workflows. Here's how: @@ -174,7 +174,7 @@ For more detailed instructions, check out our **Import/View HAR file page**. +You can keep your session data for later use or **share it** with others. Use the **Export HAR** option to download session data, which can be shared or re-imported into Requestly. To learn more, visit the **Import/View HAR file page**. ### Creating Rules from Captured Sessions diff --git a/general/sessions/record-bug-reports.mdx b/general/sessions/record-bug-reports.mdx index 84e13c5..c02fc67 100644 --- a/general/sessions/record-bug-reports.mdx +++ b/general/sessions/record-bug-reports.mdx @@ -6,14 +6,14 @@ description: >- Learn how to record screen, console logs, network lots, etc then securely share them to speed up issue resolution. seoDescription: >- - Learn how to record and share debug sessions with Session Book. Capture screen + Learn how to record and share debug sessions with Requestly Sessions. Capture screen recording, console logs, network lots, etc then securely share them to speed up issue resolution. visibility: PUBLIC --- *** -**Session Book** helps you capture and share detailed bug reports by recording browsing sessions along with mouse movements, clicks, network logs, console logs, environment details, and LocalStorage changes. It provides all the information developers need to reproduce and debug issues, a replacement of reproduction steps. +Requestly **Sessions** helps you capture and share detailed bug reports by recording browsing sessions along with mouse movements, clicks, network logs, console logs, environment details, and LocalStorage changes. It provides the information developers need to reproduce and debug issues without relying only on written reproduction steps. Let’s see how to record a bug report, save it, and share it with your team. @@ -23,7 +23,7 @@ Let’s see how to record a bug report, save it, and share it with your team. ## Configure Session Recording -To begin using **Session Book**, the first thing you'll need to do is **set up your pages**. This ensures that the right pages are ready for recording. +To begin using **Sessions**, the first thing you'll need to do is **set up your pages**. This ensures that the right pages are ready for recording. @@ -171,7 +171,7 @@ Once a recording is saved, you can share it with your team using different acces * **Only with Specific People** -For more detailed steps on how to share and manage access, visit the Access Control section. +For more detailed steps on how to share and manage access, visit the Access Control section. diff --git a/general/team/how-to-get-started-with-shared-workspace.mdx b/general/team/how-to-get-started-with-shared-workspace.mdx index 6f7f1fe..59e6a4f 100644 --- a/general/team/how-to-get-started-with-shared-workspace.mdx +++ b/general/team/how-to-get-started-with-shared-workspace.mdx @@ -1,110 +1,110 @@ --- -title: Team Workspaces -label: Team Workspaces +title: Team projects +label: Team projects slug: how-to-get-started-with-shared-workspace -description: Learn how to setup team workspace in Requestly +description: Learn how to set up a team project in Requestly visibility: PUBLIC --- -Requestly’s **Team/Shared Workspaces** make collaboration easy by **syncing** all the **workpace data** between members can work together on **HTTP rules, mock APIs, the API client, and sessions**. Whether you're debugging, testing, or managing API workflows, a shared workspace ensures your team stays in sync and productive. +Requestly’s **team and shared projects** make collaboration easy by **syncing** all **project data** so members can work together on **HTTP rules, mock APIs, the API client, and sessions**. Whether you're debugging, testing, or managing API workflows, a shared project keeps your team in sync and productive. -### Setting Up a Shared Workspace +### Setting up a shared project -Let's create a shared workspace and invite some friends to collaborate in real-time. Follow these simple steps to get started. +Let's create a shared project and invite teammates to collaborate in real time. Follow these simple steps to get started.