# request-templater > RequestTemplater is a class for generating HTTP request examples based on templates for different programming languages. Latest version **1.3.3** (published 2024-06-01) · MIT license · 0 weekly downloads ## Install ```sh npm install request-templater pnpm add request-templater yarn add request-templater bun add request-templater ``` Provides the command `request-templater`. ## Health **Score 30/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 1.3.3 | | Published | 2024-06-01 | | First published | 2023-03-24 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 1 | | Unpacked size | 3.1 MB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Pavel Kuzmin | | Maintainers | s00d | | Keywords | http, request, generator, template, programming, languages | ## Links - npm: https://www.npmjs.com/package/request-templater - Repository: https://github.com/s00d/request-templater - Homepage: https://github.com/s00d/request-templater#readme - Issues: https://github.com/s00d/request-templater/issues - npm.io page: https://npm.io/package/request-templater ## Dependencies (1) - [commander](https://npm.io/package/commander.md) ^10.0.1 ## Alternatives - [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads - [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads - [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads - [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads - [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads ## Recent versions - 1.3.3 (latest) — 2024-06-01 - 1.3.2 — 2023-11-01 - 1.3.1 — 2023-10-18 - 1.2.1 — 2023-04-02 - 1.1.2 — 2023-03-27 - 1.1.1 — 2023-03-25 - 1.0.10 — 2023-03-24 - 1.0.9 — 2023-03-24 - 1.0.8 — 2023-03-24 - 1.0.7 — 2023-03-24 - 1.0.6 — 2023-03-24 - 1.0.4 — 2023-03-24 - 1.0.3 — 2023-03-24 - 1.0.2 — 2023-03-24 - 1.0.1 — 2023-03-24 - … 1 more at https://npm.io/package/request-templater/versions ## README [![npm version](https://badge.fury.io/js/request-templater.svg)](https://badge.fury.io/js/request-templater) [![npm downloads](https://img.shields.io/npm/dw/request-templater)](https://badge.fury.io/js/request-templater) [![NPM license](https://img.shields.io/npm/l/request-templater)](https://github.com/sood/request-templater/blob/master/LICENSE) [![npm type definitions](https://img.shields.io/npm/types/request-templater)](https://github.com/sood/request-templater) [![donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://www.paypal.me/s00d) [![GitHub Repo stars](https://img.shields.io/github/stars/sood/request-templater?style=social)](https://github.com/sood/request-templater) # RequestTemplater RequestTemplater is a class for generating HTTP request examples based on templates for different programming languages. # Example [Show](https://s00d.github.io/request-templater/) ## Installation To install RequestTemplater, run the following command: ```npm install request-templater``` ## Usage To get started with RequestTemplater, create an instance of the class: ```js import RequestTemplater from 'request-templater'; const requestTemplater = new RequestTemplater(); ``` Then you can set the base URL and other request parameters: ```js requestTemplater.baseUrl('https://example.com/api') .method('GET') .url('users/123') .params([ { in: 'query', name: 'page', value: '1' }, { in: 'query', name: 'limit', value: '10' }, { in: 'headers', name: 'Authorization', value: 'Bearer xxxxxxxxxxxx' } ]); ``` After that, you can generate a request example for the desired language: ```js const code = requestTemplater.lang('javascript').library('axios').generate(); console.log(code); In this example, code in the JavaScript language will be generated using the Axios library. ``` ## Methods ### baseUrl(value: string): RequestTemplater Method for setting the base URL for requests. ### method(value: 'GET'|'POST'|'PUT'|'DELETE'|'PATCH'|'HEAD'|'OPTIONS'): RequestTemplater Method for setting the HTTP method for requests. ### url(value: string): RequestTemplater Method for setting the path for requests. ### params(value: Array): RequestTemplater Method for setting request parameters. ### mimeType(value: "application/x-www-form-urlencoded"|"application/json"|'multipart/form-data'): RequestTemplater Method for setting the MIME type for requests. ### lang(value: string): RequestTemplater Method for setting the programming language for which a request example will be generated. ### library(value: string): RequestTemplater Method for setting the library that will be used to send the request. ### generate(): string Method for generating a request example based on the specified parameters. ### generateHighlight(): string Method for generating a request example based on the specified parameters with highlight.js tags. Need add style, for example: `````` ### config(): Object Method for getting a list of available templates for generating request examples. ## Language and Libraries | Language | Libraries | |-------------|--------------------------------------| | Swift | URLSession, Alamofire | | Shell | wget, httpie, curl | | Scala | scalaj-http, http4s, akka | | Rust | surf, reqwest, hyper | | Ruby | RestClient, http | | Python | requests, http | | PowerShell | WebRequest, RestMethod | | PHP | http2, http1, Guzzle, curl | | Perl | UserAgent, Tiny, Request | | OCaml | httpaf, cohttp_lwt | | Objective-C | NSURLSession, AFNetworking | | Lua | httpclient, http, curl | | Kotlin | OkHttp3, Java, Fuel | | JavaScript | jQuery, Fetch, Axios, XMLHttpRequest | | Java | Unirest, OkHttp, NetHttp, AsyncHttp | | HTTP | RFC7230 | | Go | http, fasthttp | | Dart | http_client, http, Dio | | C# | RestSharp, HttpClient | | C++ | iostream, curl, Arduino | | Clojure | Ring-Client, clj-http | | C | ghttp, curl | | Brainfuck | Brainfuck | | R | RCurl, httr | ## cli Install the request-templater package globally using npm: ```bash npm install -g request-templater ``` To use Request Templater, run the request-templater command in your terminal, specifying the necessary parameters. For example: request-templater --url https://api.example.com/users --method POST --lang bash --library curl --params '[{in: "query", name: "param", value: 1}]' In this example, we're specifying the URL, request method, programming language (javascript), and request parameters in JSON format. Request Templater supports the following parameters: `-u, --url `: The URL of the request (required) `-m, --method `: The HTTP method (defaults to GET) `-l, --language `: The programming language to generate code in (defaults to javascript) `-t, --mimeType `: The MIME type of the request (optional) `-p, --params `: The request parameters (optional) `-b, --baseUrl `: The base URL for the request (optional) `-r, --library `: The HTTP library to use for making the request (defaults to xhr) To get help on the command line parameters, run the request-templater -h command: ```bash request-templater -h ``` --- _Source: https://npm.io/package/request-templater · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._