Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 27 additions & 13 deletions docs.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://mintlify.com/docs.json",
"theme": "palm",
"theme": "mint",
"name": "Requestly",
"description": "Modify, Mock, Record & Debug HTTP requests - Comprehensive documentation for Requestly's powerful tools for API testing, debugging, and network request manipulation.",
"colors": {
Expand All @@ -15,11 +15,16 @@
},
"favicon": "/images/favicon.webp",
"navbar": {
"links": [],
"links": [
{
"label": "Go to Dashboard",
"href": "https://app.requestly.io/signup?utm_source=docs&utm_medium=navbar&utm_campaign=get_started"
}
],
"primary": {
"type": "button",
"label": "Get Started",
"href": "https://app.requestly.io"
"label": "Download",
"href": "https://requestly.com/downloads"
}
},
"navigation": {
Expand Down Expand Up @@ -57,11 +62,20 @@
{
"group": "Sending Requests",
"pages": [
"general/api-client/send-api-request",
"general/api-client/graphql-request",
"general/api-client/authorization",
"general/api-client/replay-request-from-history",
"general/api-client/generate-client-code"
"general/api-client/send-api-request/overview",
{
"group": "Create Requests",
"pages": [
"general/api-client/send-api-request/create-requests/overview",
"general/api-client/send-api-request/create-requests/configure-request",
"general/api-client/send-api-request/create-requests/parameters-and-body",
"general/api-client/send-api-request/create-requests/request-headers",
"general/api-client/send-api-request/create-requests/generate-client-code"
]
},
"general/api-client/send-api-request/graphql-request",
"general/api-client/send-api-request/authorization",
"general/api-client/send-api-request/replay-request-from-history"
]
},
{
Expand Down Expand Up @@ -965,12 +979,12 @@
"destination": "/general/api-client/rq-api-reference/rq-expect"
},
{
"source":"/guides/modify-network-request-for-browserstack-local",
"destination":"/guides/requestly-integration-browserstack-app-live"
"source": "/guides/modify-network-request-for-browserstack-local",
"destination": "/guides/requestly-integration-browserstack-app-live"
},
{
"source":"/using-rules/modify-headers",
"destination":"/general/http-rules/rule-types/modify-headers"
"source": "/using-rules/modify-headers",
"destination": "/general/http-rules/rule-types/modify-headers"
}
]
}
3 changes: 3 additions & 0 deletions general/api-client/ai-test-generator.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ Simply describe what you want to validate in plain English. The agent analyzes y
**Note**: The Test Authoring Agent is available only on **Pro plans and above**.
</Tip>

<iframe className="w-full aspect-video rounded-xl" src="https://www.youtube.com/embed/iv4MvArAdYU?si=WsJdhBkKWmTua7RG" />


## Getting Started with AI Test Cases Generator

<Steps>
Expand Down
87 changes: 0 additions & 87 deletions general/api-client/authorization.mdx

This file was deleted.

2 changes: 2 additions & 0 deletions general/api-client/collection-runner-data-file.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ This enables you to iterate through your requests using multiple sets of input v

Use this feature to test APIs with dynamic inputs, such as running the same workflow for multiple users, IDs, or configurations.

<iframe className="w-full aspect-video rounded-xl" src="https://www.youtube.com/embed/j-oh6pe51Vw?si=RUH0MpYQ3bdTdgJd" />

### Using a Data File in Collection Runner

Follow these steps to run a collection with custom data:
Expand Down
3 changes: 3 additions & 0 deletions general/api-client/import-export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ This section covers everything you need to know about:

* Exporting your collections or environments for sharing, syncing, or backup

<iframe className="w-full aspect-video rounded-xl" src="https://www.youtube.com/embed/qS6R5rejAsM?si=gyKcYJWACr5w3S09" />


## Supported Imports

* [Import from cURL](/general/api-client/import-export/import-from-curl)
Expand Down
3 changes: 3 additions & 0 deletions general/api-client/import-export/import-openapi-spec.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ Import your **OpenAPI Specification** files directly into the **Requestly,** and

This helps you bring your existing API definitions from Swagger, Postman, or your backend documentation straight into Requestly in just a few clicks.

<iframe className="w-full aspect-video rounded-xl" src="https://www.youtube.com/embed/N3ZqNfI5omw?si=2oWuS5ySagf6NWJK" />


## What You Can Import

The importer supports both **YAML** and **JSON** OpenAPI files. When you upload a spec, Requestly automatically reads the file and creates API collections and requests based on your defined endpoints.
Expand Down
2 changes: 2 additions & 0 deletions general/api-client/import-packages-into-your-scripts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ You can use the `require` method to import preloaded libraries or global helpers

The script environment supports JavaScript-based transformations, validations, and dynamic request logic for HTTP and GraphQL APIs.

<iframe className="w-full aspect-video rounded-xl" src="https://www.youtube.com/embed/C21BaqCOxF0?si=8vv_iOh1d4xEqeK3" />

## **require**

The `require` method lets you import supported modules into your script. Declare the result as a variable to access functions or objects from that module.
Expand Down
12 changes: 6 additions & 6 deletions general/api-client/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -173,13 +173,13 @@ Ready to start testing APIs? Follow these quick steps:
## Next Steps

<CardGroup cols={3}>
<Card title="Master Variables" href="/general/api-client/environments-and-variables" icon="graduation-cap">
Deep dive into variable types and usage
<Card title="Quick Start Guide" icon="rocket" href="/general/api-client/quick-start">
New to API Client? Start here with our beginner-friendly guide
</Card>
<Card title="Write Tests" href="/general/api-client/tests" icon="flask">
Add automated testing to your workflow
<Card title="Send Your First Request" icon="paper-plane" href="/general/api-client/send-api-request">
Learn how to send API requests and view responses
</Card>
<Card title="Collaborate" href="/general/team/workspaces" icon="users">
Share APIs with your team workspace
<Card title="Create Collections" icon="folder" href="/general/api-client/api-collections">
Organize your APIs into collections for better project management
</Card>
</CardGroup>
Loading