Package Exports

@scalar/snippetz
@scalar/snippetz/plugins/c/libcurl
@scalar/snippetz/plugins/clojure/clj_http
@scalar/snippetz/plugins/csharp/httpclient
@scalar/snippetz/plugins/csharp/restsharp
@scalar/snippetz/plugins/dart/http
@scalar/snippetz/plugins/go/native
@scalar/snippetz/plugins/http/http11
@scalar/snippetz/plugins/java/asynchttp
@scalar/snippetz/plugins/java/nethttp
@scalar/snippetz/plugins/java/okhttp
@scalar/snippetz/plugins/java/unirest
@scalar/snippetz/plugins/js/axios
@scalar/snippetz/plugins/js/fetch
@scalar/snippetz/plugins/js/jquery
@scalar/snippetz/plugins/js/ofetch
@scalar/snippetz/plugins/js/xhr
@scalar/snippetz/plugins/kotlin/okhttp
@scalar/snippetz/plugins/node/axios
@scalar/snippetz/plugins/node/fetch
@scalar/snippetz/plugins/node/ofetch
@scalar/snippetz/plugins/node/undici
@scalar/snippetz/plugins/objc/nsurlsession
@scalar/snippetz/plugins/ocaml/cohttp
@scalar/snippetz/plugins/php/curl
@scalar/snippetz/plugins/php/guzzle
@scalar/snippetz/plugins/powershell/restmethod
@scalar/snippetz/plugins/powershell/webrequest
@scalar/snippetz/plugins/python/httpx
@scalar/snippetz/plugins/python/python3
@scalar/snippetz/plugins/python/requests
@scalar/snippetz/plugins/r/httr
@scalar/snippetz/plugins/ruby/native
@scalar/snippetz/plugins/rust/reqwest
@scalar/snippetz/plugins/shell/curl
@scalar/snippetz/plugins/shell/httpie
@scalar/snippetz/plugins/shell/wget
@scalar/snippetz/plugins/swift/nsurlsession
@scalar/snippetz/utils

Readme

Snippetz

A modern way to generate HTTP request examples for different languages and libraries.

Installation

npm install @scalar/snippetz

Usage

import { snippetz } from '@scalar/snippetz'

const snippet = snippetz().print('node', 'undici', {
  url: 'https://example.com',
})

/* Output */

// import { request } from 'undici'
//
// const { statusCode, body } = await request(
//   'https://example.com',
// )

API

Get all plugins

import { snippetz } from '@scalar/snippetz'

const snippet = snippetz().plugins()

/* Output */

// [
//   {
//     target: 'node',
//     client: 'undici',
//   }
// ]

Check if a plugin is loaded

import { snippetz } from '@scalar/snippetz'

const snippet = snippetz().hasPlugin('node', 'undici')

/* Output */

// true

Lean usage

You can also just use one specific plugin to keep your bundle size small.

import { nodeUndici } from '@scalar/snippetz/plugins/node/undici'

const result = nodeUndici.generate({
  url: 'https://example.com',
})

console.log(source)

// import { request } from 'undici'

// const { statusCode, body } = await request(
//   'url': 'https://example.com',
// )

Community

We are API nerds. You too? Let's chat on Discord: https://discord.gg/scalar

License

The source code in this repository is licensed under MIT.