HTTPSnippet

HTTPSnippet converts HTTP requests in HAR (HTTP Archive) format into executable code for various languages and tools. The conversion process is governed by three concepts:

1. Target: A group of code generators, typically representing a programming language (e.g., Rust, Go, C, OCaml).
2. Client: A specific generator within a target, referring to a particular library (e.g., the C# target has httpclient and restsharp clients).
3. Options: Per-client configuration settings used to control formatting, such as indentation behavior.

Input is a JSON object representing a HAR request or a full HAR log.

You can install the HTTPSnippet CLI globally using npm or yarn to convert HAR files to code snippets from your terminal.

npm install --global httpsnippet
# or
yarn global add httpsnippet

To use HTTPSnippet programmatically in your TypeScript or JavaScript projects, install it as a dependency.

npm install --save httpsnippet
# or
yarn add httpsnippet

When you initialize HTTPSnippet, it processes raw HAR data into an enriched Request object. This object contains the original HAR data plus several helper objects to make snippet generation easier.

Key Properties

• fullUrl: The complete URL including the query string.
• url: The base URL without the query string.
• uriObj: A parsed URL object containing pathname, query, search, and path.
• headersObj: An object containing all request headers (keys are normalized based on the HTTP version).
• queryObj: An object containing the parsed query string parameters.
• cookiesObj: An object containing the request cookies.
• allHeaders: A merged object containing both standard headers and the cookie header string.
• postData: The request body, which includes jsonObj (for JSON requests) or paramsObj (for form-encoded requests).

Initialize a new HTTPSnippet instance with a HarRequest or HarEntry object, then call .convert() to generate the code.

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

• targetId: The ID of the target (e.g., 'node', 'shell', 'go').
• clientId (Optional): The specific client within the target. If omitted, the target's default client is used.
• options (Optional): An object containing client-specific configuration (e.g., { indent: '\t' }).

import { HTTPSnippet } from 'httpsnippet';

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

// Generate default client for 'node'
console.log(snippet.convert('node'));

// Generate 'node' with specific indentation
console.log(
  snippet.convert('node', undefined, {
    indent: '\t',
  }),
);

You can add your own custom generators to HTTPSnippet using addTarget and addTargetClient.

• addTarget(target: Target): Adds a completely new target.
• addTargetClient(targetId: TargetId, client: Client): Adds a new client to an existing target.
• isTarget(target: any): Type guard to validate if an object is a valid Target.
• isClient(client: any): Type guard to validate if an object is a valid Client.

import { HTTPSnippet, addTargetClient, isTarget, isClient } from 'httpsnippet';

// Adding a custom client to an existing target
addTargetClient('customTargetId', myCustomClient);

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

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

The RubyNativeOptions interface allows you to control SSL behavior in the generated Ruby code.

export interface RubyNativeOptions {
  insecureSkipVerify?: boolean;
}

When using the python3 client in httpsnippet, you can provide an optional Python3Options object to control SSL verification behavior.

• insecureSkipVerify (boolean, optional): If set to true, the generated Python code will import the ssl module and use ssl._create_unverified_context() to bypass SSL certificate verification. Defaults to false.

When using the http2 client to generate PHP code snippets, you can pass an Http2Options object to customize the output format.

Supported options:

• closingTag (boolean): If true, appends a PHP closing tag ?> to the end of the snippet.
• noTags (boolean): If true, the generated code will not include PHP opening tags (<?php or <?).
• shortTags (boolean): If true and noTags is false, uses the short opening tag <? instead of <?php.

export interface Http2Options {
  closingTag?: boolean;
  noTags?: boolean;
  shortTags?: boolean;
}

When using the httr client for code generation, you can provide an options object to control the formatting of the output. Currently, the only available option is indent.

export interface HttrOptions {
  /** @default '  ' */
  indent?: string;
}

When using the Crystal native client target, you can pass the following options to customize the generated code:

When using the guzzle target to generate PHP code snippets, you can pass a GuzzleOptions object to customize the output format.

Available options:

• closingTag (boolean): If true, appends a PHP closing tag ?> to the snippet.
• indent (string): The string used for indentation (e.g., ' ' or ' ').
• noTags (boolean): If true, the snippet will not include the opening <?php or <? tag.
• shortTags (boolean): If true and noTags is false, uses the short PHP opening tag <? instead of <?php.

export interface GuzzleOptions {
  closingTag?: boolean;
  indent?: string;
  noTags?: boolean;
  shortTags?: boolean;
}