HTTPSnippet

[![version][npm-version]][npm-url] [![License][npm-license]][license-url]

Note for JCI Developers

Changes are published to NPM manually. To publish:

- Make changes.
- Submit a PR (make sure to update the version in package.json and package-lock.json)
- Once PR is approved, you can publish but first, you will need to be authenticated to NPM JS for the metasys org (request access as needed).

``bash
npm login
npm run build
npm publish
`

> HTTP Request snippet generator for _many_ languages & tools including: cURL, HTTPie, JavaScript, Node, C, Java, PHP, Objective-C, Swift, Python, Ruby, C#, Go, OCaml, Crystal and more!

Relies on the popular HAR format to import data and describe HTTP calls.

See it in action on companion service: APIembed

![Build](https://github.com/Kong/httpsnippet/actions/workflows/build.yml) [![Downloads][npm-downloads]][npm-url]

- HTTPSnippet
- Note for JCI Developers
- Quickstart
- Core Concepts
- CLI Quickstart
- TypeScript Library Quickstart
- CLI Usage
- CLI Installation
- Example
- TypeScript Library Usage
- Library Installation
- Types
- HarRequest
- HarEntry
- TargetId
- ClientId
- Converter
- Client
- ClientInfo
- Extension
- TargetInfo
- Target
- Library Exports
- new HTTPSnippet(source: HarRequest | HarEntry)
- snippet.convert(targetId: string, clientId?: string, options?: T)
- isTarget
- addTarget
- isClient
- addTargetClient
- Bugs and feature requests
- Contributing

Quickstart

$3

1. HTTPSnippet's input is a JSON object that represents an HTTP request in the HAR Request Object format.
1. HTTPSnippet's output is executable code that sends the input HTTP request, in a wide variety of languages and libraries.
1. You provide HTTPSnippet your desired target, client, and options.
- a target refers to a group of code generators. Generally, a target is a _programming language_ like Rust, Go, C, or OCaml.
- client refers to a more specific generator within the parent target. For example, the C# target has two available clients, httpclient and restsharp, each referring to a popular C# library for making requests.
- options are per client and generally control things like specific indent behaviors or other formatting rules.

$3

`shell
httpsnippet har.json \ # the path your input file (must be in HAR format)
--target shell \ # your desired language
--client curl \ # your desired language library
--output ./examples \ # an output directory, otherwise will just output to Stdout
--options '{ "indent": false }' # any client options as a JSON string
`

$3

`ts
import { HTTPSnippet } from 'httpsnippet';

const snippet = new HTTPSnippet({
method: 'GET',
url: 'http://mockbin.com/request',
});

const options = { indent: '\t' };
const output = snippet.convert('shell', 'curl', options);
console.log(output);
`

CLI Usage

$3

| NPM | Yarn |
| ------------------------------------------- | -------------------------------------- |
|

npm install --global httpsnippet

yarn global add httpsnippet

`text
httpsnippet [harFilePath]

the default command

Options:
--help Show help [boolean]
--version Show version number [boolean]
-t, --target target output [string] [required]
-c, --client language client [string]
-o, --output write output to directory [string]
-x, --options provide extra options for the target/client [string]

Examples:
httpsnippet my_har.json --target rust --client actix --output my_src_directory
`

$3

The input to HTTPSnippet is any valid HAR Request Object, or full HAR log format.

`shell
httpsnippet example.json --target shell --client curl --output ./examples
`

`console
$ tree examples
examples/
└── example.sh
`

inside examples/example.sh you'll see the generated output:

`shell
curl --request POST \
--url 'http://mockbin.com/har?foo=bar&foo=baz&baz=abc&key=value' \
--header 'accept: application/json' \
--header 'content-type: application/x-www-form-urlencoded' \
--cookie 'foo=bar; bar=baz' \
--data foo=bar
`

provide extra options:

`shell
httpsnippet example.json --target shell --client curl --output ./examples --options '{ "indent": false }'
`

and see how the output changes, in this case without indentation

`shell
curl --request POST --url 'http://mockbin.com/har?foo=bar&foo=baz&baz=abc&key=value' --header 'accept: application/json' --header 'content-type: application/x-www-form-urlencoded' --cookie 'foo=bar; bar=baz' --data foo=bar
`

TypeScript Library Usage

$3

| NPM | Yarn |
| ----------------------------------------- | ------------------------------- |
|

npm install --save httpsnippet

yarn add httpsnippet

#### HarRequest

See for the TypeScript type corresponding to this type

#### HarEntry

`ts
interface Entry {
request: Partial;
}

interface HarEntry {
log: {
version: string;
creator: {
name: string;
version: string;
};
entries: {
request: Partial;
}[];
};
}
`

#### TargetId

`ts
type TargetId = string;
`

#### ClientId

`ts
type ClientId = string;
`

#### Converter

`ts
type Converter> = (
request: Request,
options?: Merge,
) => string;
`

#### Client

`ts
interface Client = Record> {
info: ClientInfo;
convert: Converter;
}
`

#### ClientInfo

`ts
interface ClientInfo {
key: ClientId;
title: string;
link: string;
description: string;
}
`

#### Extension

`ts
type Extension = .${string} | null;
`

#### TargetInfo

`ts
interface TargetInfo {
key: TargetId;
title: string;
extname: Extension;
default: string;
}
`

#### Target

`ts
interface Target {
info: TargetInfo;
clientsById: Record;
}
`

$3

#### new HTTPSnippet(source: HarRequest | HarEntry)

Name of conversion target

`ts
import { HTTPSnippet } from 'httpsnippet';

const snippet = new HTTPSnippet({
method: 'GET',
url: 'http://mockbin.com/request',
});
`

#### snippet.convert(targetId: string, clientId?: string, options?: T)

The convert method requires a target ID such as node, shell, go, etc. If no client ID is provided, the default client for that target will be used.

> Note: to see the default targets for a given client, see target.info.default. For example shell's target has the default of curl.

Many targets provide specific options. Look at the TypeScript types for the target you are interested in to see what options it provides. For example shell:curl's options correspond to the CurlOptions interface in the shell:curl client file.

`ts
import { HTTPSnippet } from 'httpsnippet';

const snippet = new HTTPSnippet({
method: 'GET',
url: 'http://mockbin.com/request',
});

// generate Node.js: Native output
console.log(snippet.convert('node'));

// generate Node.js: Native output, indent with tabs
console.log(
snippet.convert('node', {
indent: '\t',
}),
);
`

#### isTarget

Useful for validating that a custom target is considered valid by HTTPSnippet.

`ts
const isTarget: (target: Target) => target is Target;
`

`ts
import { myCustomTarget } from './my-custom-target';
import { isTarget } from 'httpsnippet';

try {
console.log(isTarget(myCustomTarget));
} catch (error) {
console.error(error);
}
`

#### addTarget

Use addTarget to add a new custom target that you can then use in your project.

`ts
const addTarget: (target: Target) => void;
`

`ts
import { myCustomClient } from './my-custom-client';
import { HAR } from 'my-custom-har';
import { HTTPSnippet, addTargetClient } from 'httpsnippet';

addTargetClient(myCustomClient);

const snippet = new HTTPSnippet(HAR);
const output = snippet.convert('customTargetId');
console.log(output);
`

#### isClient

Useful for validating that a custom client is considered valid by HTTPSnippet.

`ts
const isClient: (client: Client) => client is Client;
`

`ts
import { myCustomClient } from './my-custom-client';
import { isClient } from 'httpsnippet';

try {
console.log(isClient(myCustomClient));
} catch (error) {
console.error(error);
}
`

#### addTargetClient

Use addTargetClient to add a custom client to an existing target. See addTarget for how to add a custom target.

`ts
const addTargetClient: (targetId: TargetId, client: Client) => void;
`

`ts
import { myCustomClient } from './my-custom-client';
import { HAR } from 'my-custom-har';
import { HTTPSnippet, addTargetClient } from 'httpsnippet';

addTargetClient('customTargetId', myCustomClient);

const snippet = new HTTPSnippet(HAR);
const output = snippet.convert('customTargetId', 'customClientId');
console.log(output);
``

Bugs and feature requests

Have a bug or a feature request? Please first read the issue guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

For info on creating new conversion targets, please review this guideline

Moreover, if your pull request contains TypeScript patches or features, you must include relevant unit tests.

Editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at .

[license-url]: https://github.com/Kong/httpsnippet/blob/master/LICENSE
[npm-url]: https://www.npmjs.com/package/httpsnippet
[npm-license]: https://img.shields.io/npm/l/httpsnippet.svg?style=flat-square
[npm-version]: https://img.shields.io/npm/v/httpsnippet.svg?style=flat-square
[npm-downloads]: https://img.shields.io/npm/dm/httpsnippet.svg?style=flat-square