Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update the importer page with additional data imported from each source #260

Merged
merged 5 commits into from
Nov 28, 2024
Merged

docs: update the importer page with additional data imported from each source #260

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ba61094
docs: update the importer page with additional data imported from eac…
SanskritiHarmukh Nov 14, 2024
093bbf2
fixing typo
SanskritiHarmukh Nov 15, 2024
2ecd9fe
fixing typo
SanskritiHarmukh Nov 15, 2024
42d9ed5
fixing typo
SanskritiHarmukh Nov 15, 2024
8d5e4ca
update: add value term for secret variable message while importing fr…
SanskritiHarmukh Nov 18, 2024
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
22 changes: 21 additions & 1 deletion documentation/features/importer.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@ Import data from other tools into Hoppscotch. You can import data from the follo
4. Choose the "**collection**" from the list.
5. Click on the "**Import**" button.

### <Icon icon="download" iconType="solid" /> What’s Imported in the above 2 cases
- **Collections:** Complete set of request details, including parameters, request bodies, headers, authorization settings, pre-request scripts, test cases, request variables, response examples and collection-level properties are retained.
- **Environments:** Regular environment variables are imported.

<Info> **Secret variables' values** need to be manually entered as they aren't stored server-side for security reasons. </Info>

## Import from Postman

1. Export your Postman collection/environment to a JSON file.
Expand All @@ -41,6 +47,10 @@ Import data from other tools into Hoppscotch. You can import data from the follo
4. Click on the "**Choose file**" button and select the JSON file you exported in step 1.
5. Click on the "**Import**" button.

### <Icon icon="download" iconType="solid" /> What's Imported
- **Collections:** Query parameters from Postman are imported as request parameters and path parameters are imported as request variables. Request bodies, headers, and basic authorization are also imported. Pre-request scripts, test cases, Advanced authorization setups, and collection-level settings aren’t imported.
- **Environments:** Imports both regular and secret environment variables directly.

## Import from Insomnia

1. Export your Insomnia collection/environment to a JSON file.
Expand All @@ -49,6 +59,10 @@ Import data from other tools into Hoppscotch. You can import data from the follo
4. Click on the "**Choose file**" button and select the JSON file you exported in step 1.
5. Click on the "**Import**" button.

### <Icon icon="download" iconType="solid" /> What's Imported
- **Collections:** Request details like query parameters are imported as request parameters, and path parameters are imported as request variables. Request bodies, headers, and basic authorization settings are also imported. However, other sections like scripts, tests, and advanced authorization methods aren’t synced.
- **Environments:** Regular environment variables are imported.

## Import from OpenAPI

There are two ways to import OpenAPI collections into Hoppscotch:
Expand All @@ -69,6 +83,9 @@ There are two ways to import OpenAPI collections into Hoppscotch:
5. Click on the "**Import from URL**" field and paste the URL that you copied in step 1.
6. Click on the "**Import**" button.

### <Icon icon="download" iconType="solid" /> What's Imported
- **Collections:** Query parameters are imported as request parameters, and path parameters are imported as request variables. Authorization methods, headers, and response examples are also included. However, details like request bodies, scripts, and tests aren’t imported.

## Import from HAR

1. Export the HTTP Archive (HAR) file from your browser or network monitoring tool.
Expand All @@ -77,6 +94,9 @@ There are two ways to import OpenAPI collections into Hoppscotch:
4. Click on the "**Choose file**" button and select the HAR file you exported in step 1.
5. Click on the "**Import**" button.

### <Icon icon="download" iconType="solid" /> What's Imported
- **Collections:** Imports request headers and body content. Additional metadata or settings aren’t included in this format.

## Import from other services

- If you want to import data from other services, please [contact support](/support/getting-started/contact) and we will help you out.
Expand All @@ -86,4 +106,4 @@ There are two ways to import OpenAPI collections into Hoppscotch:
You can import cURL commands into Hoppscotch in the following ways:

- **Copy and paste**: Copy and paste the cURL command into the Hoppscotch URL bar.
- **Send drop-down menu**: Click on the send drop-down menu and select "**Import cURL**". Paste the cURL command into the text area and click on the "**Import**" button.
- **Send drop-down menu**: Click on the send drop-down menu and select "**Import cURL**". Paste the cURL command into the text area and click on the "**Import**" button.