mirror of
https://github.com/Kong/insomnia
synced 2024-11-08 14:49:53 +00:00
219 lines
6.6 KiB
Markdown
Executable File
219 lines
6.6 KiB
Markdown
Executable File
# HTTP Snippet [![version][npm-version]][npm-url] [![License][npm-license]][license-url]
|
|
|
|
> HTTP Request snippet generator for *many* languages & tools including: `cURL`, `HTTPie`, `Javascript`, `Node`, `C`, `Java`, `PHP`, `Objective-C`, `Swift`, `Python`, `Ruby`, `C#`, `Go`, `OCaml` and [more](https://github.com/Mashape/httpsnippet/wiki/Targets)!
|
|
|
|
Relies on the popular [HAR](http://www.softwareishard.com/blog/har-12-spec/#request) format to import data and describe HTTP calls.
|
|
|
|
See it in action on companion service: [APIembed](https://apiembed.com/)
|
|
|
|
[![Build Status][travis-image]][travis-url]
|
|
[![Downloads][npm-downloads]][npm-url]
|
|
[![Code Climate][codeclimate-quality]][codeclimate-url]
|
|
[![Coverage Status][codeclimate-coverage]][codeclimate-url]
|
|
[![Dependencies][david-image]][david-url]
|
|
[![Gitter][gitter-image]][gitter-url]
|
|
|
|
## Install
|
|
|
|
```shell
|
|
# to use in cli
|
|
npm install --global httpsnippet
|
|
|
|
# to use as a module
|
|
npm install --save httpsnippet
|
|
```
|
|
|
|
## Usage
|
|
|
|
```
|
|
|
|
Usage: httpsnippet [options] <file>
|
|
|
|
Options:
|
|
|
|
-h, --help output usage information
|
|
-V, --version output the version number
|
|
-t, --target <target> target output
|
|
-c, --client [client] target client library
|
|
-o, --output <directory> write output to directory
|
|
|
|
```
|
|
|
|
###### Example
|
|
|
|
process single file: [`example.json`](test/fixtures/requests/full.json) in [HAR Request Object](http://www.softwareishard.com/blog/har-12-spec/#request) format, or full [HAR](http://www.softwareishard.com/blog/har-12-spec/#log) log format:
|
|
|
|
```shell
|
|
httpsnippet example.json --target node --client unirest --output ./snippets
|
|
```
|
|
|
|
```shell
|
|
$ tree snippets
|
|
snippets/
|
|
└── example.js
|
|
```
|
|
|
|
process multiple files:
|
|
|
|
```shell
|
|
httpsnippet ./*.json --target node --client request --output ./snippets
|
|
```
|
|
|
|
```shell
|
|
$ tree snippets/
|
|
snippets/
|
|
├── endpoint-1.js
|
|
├── endpoint-2.js
|
|
└── endpoint-3.js
|
|
```
|
|
|
|
## API
|
|
|
|
### HTTPSnippet(source)
|
|
|
|
#### source
|
|
|
|
*Required*
|
|
Type: `object`
|
|
|
|
Name of [conversion target](https://github.com/Mashape/httpsnippet/wiki/Targets)
|
|
|
|
```js
|
|
var HTTPSnippet = require('httpsnippet');
|
|
|
|
var snippet = new HTTPSnippet({
|
|
method: 'GET',
|
|
url: 'http://mockbin.com/request'
|
|
});
|
|
```
|
|
|
|
### convert(target [, options])
|
|
|
|
#### target
|
|
|
|
*Required*
|
|
Type: `string`
|
|
|
|
Name of [conversion target](https://github.com/Mashape/httpsnippet/wiki/Targets)
|
|
|
|
#### options
|
|
|
|
Type: `object`
|
|
|
|
Target options, *see [wiki](https://github.com/Mashape/httpsnippet/wiki/Targets) for details*
|
|
|
|
```js
|
|
var HTTPSnippet = require('httpsnippet');
|
|
|
|
var 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'
|
|
}));
|
|
```
|
|
|
|
### convert(target [, client, options])
|
|
|
|
#### target
|
|
|
|
*Required*
|
|
Type: `string`
|
|
|
|
Name of [conversion target](https://github.com/Mashape/httpsnippet/wiki/Targets)
|
|
|
|
#### client
|
|
|
|
Type: `string`
|
|
|
|
Name of conversion target [client library](https://github.com/Mashape/httpsnippet/wiki/Targets)
|
|
|
|
#### options
|
|
|
|
Type: `object`
|
|
|
|
Target options, *see [wiki](https://github.com/Mashape/httpsnippet/wiki/Targets) for details*
|
|
|
|
```js
|
|
var HTTPSnippet = require('httpsnippet');
|
|
|
|
var snippet = new HTTPSnippet({
|
|
method: 'GET',
|
|
url: 'http://mockbin.com/request'
|
|
});
|
|
|
|
// generate Shell: cURL output
|
|
console.log(snippet.convert('shell', 'curl', {
|
|
indent: '\t'
|
|
}));
|
|
|
|
// generate Node.js: Unirest output
|
|
console.log(snippet.convert('node', 'unirest'));
|
|
```
|
|
|
|
## Documentation
|
|
|
|
At the heart of this module is the [HAR Format](http://www.softwareishard.com/blog/har-12-spec/#request) as the HTTP request description format, please review some of the sample JSON HAR Request objects in [test fixtures](/test/fixtures/requests), or read the [HAR Docs](http://www.softwareishard.com/blog/har-12-spec/#request) for more details.
|
|
|
|
For detailed information on each target, please review the [wiki](https://github.com/Mashape/httpsnippet/wiki).
|
|
|
|
## Bugs and feature requests
|
|
|
|
Have a bug or a feature request? Please first read the [issue guidelines](CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](/issues).
|
|
|
|
## Contributing
|
|
|
|
Please read through our [contributing guidelines](CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
|
|
|
|
For info on creating new conversion targets, please review this [guideline](https://github.com/Mashape/httpsnippet/wiki/Creating-Targets)
|
|
|
|
More over, if your pull request contains JavaScript patches or features, you must include relevant unit tests.
|
|
|
|
Editor preferences are available in the [editor config](.editorconfig) for easy use in common text editors. Read more and download plugins at <http://editorconfig.org>.
|
|
|
|
## Versioning
|
|
|
|
For transparency into our release cycle and in striving to maintain backward compatibility, this project is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to these rules whenever possible.
|
|
|
|
Releases will be numbered with the following format:
|
|
|
|
`<major>.<minor>.<patch>`
|
|
|
|
And constructed with the following guidelines:
|
|
|
|
- Breaking backward compatibility **bumps the major** while resetting minor and patch
|
|
- New additions without breaking backward compatibility **bumps the minor** while resetting the patch
|
|
- Bug fixes and misc changes **bumps only the patch**
|
|
|
|
For more information on SemVer, please visit <http://semver.org/>.
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE) © [Mashape](https://www.mashape.com)
|
|
|
|
[license-url]: https://github.com/Mashape/httpsnippet/blob/master/LICENSE
|
|
|
|
[travis-url]: https://travis-ci.org/Mashape/httpsnippet
|
|
[travis-image]: https://img.shields.io/travis/Mashape/httpsnippet.svg?style=flat-square
|
|
|
|
[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
|
|
|
|
[codeclimate-url]: https://codeclimate.com/github/Mashape/httpsnippet
|
|
[codeclimate-quality]: https://img.shields.io/codeclimate/github/Mashape/httpsnippet.svg?style=flat-square
|
|
[codeclimate-coverage]: https://img.shields.io/codeclimate/coverage/github/Mashape/httpsnippet.svg?style=flat-square
|
|
|
|
[david-url]: https://david-dm.org/Mashape/httpsnippet
|
|
[david-image]: https://img.shields.io/david/Mashape/httpsnippet.svg?style=flat-square
|
|
|
|
[gitter-url]: https://gitter.im/Mashape/httpsnippet
|
|
[gitter-image]: https://img.shields.io/badge/Gitter-Join%20Chat-blue.svg?style=flat-square
|