insomnia/packages/insomnia-importers/README.md

67 lines
1.1 KiB
Markdown
Raw Normal View History

# Importers
[![Npm Version](https://img.shields.io/npm/v/insomnia-importers.svg)](https://www.npmjs.com/package/insomnia-importers)
2021-08-27 03:44:01 +00:00
This repository contains converters to translate popular HTTP data formats to the latest Insomnia format.
2021-08-27 03:44:01 +00:00
Supported import types include:
- Insomnia v1, v2, v3, v4
- Postman v2.0
2021-08-27 03:44:01 +00:00
- Postman Environment
- HTTP Archive Format 1.2 (HAR)
2021-08-27 03:44:01 +00:00
- cURL
- Swagger 2.0
- OpenAPI 3.0
2021-08-27 03:44:01 +00:00
- WSDL
## Installation
For usage on **command line**, install globally
2021-08-27 03:44:01 +00:00
```shell
npm install -g insomnia-importers
```
For programmatic usage, install in project
2021-08-27 03:44:01 +00:00
```shell
npm install insomnia-importers
```
## Command Line Usage
```shell
insomnia-import /path/to/har-export.json > insomnia-export.json
```
## Programmatic Usage
2021-08-27 03:44:01 +00:00
```ts
import { importers } from 'insomnia-importers';
(async function () {
// Convert a Curl command
const output = await importers.convert(
'curl -X POST https://insomnia.rest --data "Cool!"'
);
// Pretty print the result
console.log(JSON.stringify(output.data, null, 2));
})();
```
## Running Tests
Run all tests
```shell
npm run test
```
Run test watcher
```shell
npm run test:watch
```