RequestTemplater is a class for generating HTTP request examples based on templates for different programming languages.
To install RequestTemplater, run the following command:
npm install request-templater
To get started with RequestTemplater, create an instance of the class:
import RequestTemplater from 'request-templater';
const requestTemplater = new RequestTemplater();Then you can set the base URL and other request parameters:
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:
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.Method for setting the base URL for requests.
Method for setting the HTTP method for requests.
Method for setting the path for requests.
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.
Method for setting the programming language for which a request example will be generated.
Method for setting the library that will be used to send the request.
Method for generating a request example based on the specified parameters.
Method for generating a request example based on the specified parameters with highlight.js tags.
Need add style, for example: <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.7.0/styles/tokyo-night-dark.min.css" integrity="sha512-dSQLLtgaq2iGigmy9xowRshaMzUHeiIUTvJW/SkUpb1J+ImXOPNGAI7ZC8V5/PiN/XN83B8uIk4qET7AMhdC5Q==" crossorigin="anonymous" referrerpolicy="no-referrer" />
Method for getting a list of available templates for generating request examples.
| 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 |
Install the request-templater package globally using npm:
npm install -g request-templaterTo 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 <url>: The URL of the request (required)
-m, --method <method>: The HTTP method (defaults to GET)
-l, --language <language>: The programming language to generate code in (defaults to javascript)
-t, --mimeType <mimeType>: The MIME type of the request (optional)
-p, --params <params>: The request parameters (optional)
-b, --baseUrl <baseUrl>: The base URL for the request (optional)
-r, --library <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:
request-templater -h