@readme/httpsnippet 3.1.3 → 4.0.0

package/src/targets/java/unirest/fixtures/cookies.java

@@ -0,0 +1,3 @@
+HttpResponse<String> response = Unirest.get("https://httpbin.org/cookies")
+  .header("cookie", "foo=bar; bar=baz")
+  .asString();

package/src/targets/java/unirest/fixtures/custom-method.java

@@ -0,0 +1,2 @@
+HttpResponse<String> response = Unirest.customMethod("PROPFIND","https://httpbin.org/anything")
+  .asString();

package/src/targets/java/unirest/fixtures/full.java

@@ -0,0 +1,6 @@
+HttpResponse<String> response = Unirest.post("https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value")
+  .header("cookie", "foo=bar; bar=baz")
+  .header("accept", "application/json")
+  .header("content-type", "application/x-www-form-urlencoded")
+  .body("foo=bar")
+  .asString();

package/src/targets/java/unirest/fixtures/headers.java

@@ -0,0 +1,5 @@
+HttpResponse<String> response = Unirest.get("https://httpbin.org/headers")
+  .header("accept", "application/json")
+  .header("x-foo", "Bar")
+  .header("x-bar", "Foo")
+  .asString();

package/src/targets/java/unirest/fixtures/http-insecure.java

@@ -0,0 +1,2 @@
+HttpResponse<String> response = Unirest.get("http://httpbin.org/anything")
+  .asString();

package/src/targets/java/unirest/fixtures/jsonObj-multiline.java

@@ -0,0 +1,4 @@
+HttpResponse<String> response = Unirest.post("https://httpbin.org/anything")
+  .header("content-type", "application/json")
+  .body("{\n  \"foo\": \"bar\"\n}")
+  .asString();

package/src/targets/java/unirest/fixtures/jsonObj-null-value.java

@@ -0,0 +1,4 @@
+HttpResponse<String> response = Unirest.post("https://httpbin.org/anything")
+  .header("content-type", "application/json")
+  .body("{\"foo\":null}")
+  .asString();

package/src/targets/java/unirest/fixtures/multipart-data.java

@@ -0,0 +1,4 @@
+HttpResponse<String> response = Unirest.post("https://httpbin.org/anything")
+  .header("content-type", "multipart/form-data; boundary=---011000010111000001101001")
+  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"foo\"; filename=\"hello.txt\"\r\nContent-Type: text/plain\r\n\r\nHello World\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bar\"\r\n\r\nBonjour le monde\r\n-----011000010111000001101001--\r\n")
+  .asString();

package/src/targets/java/unirest/fixtures/multipart-file.java

@@ -0,0 +1,4 @@
+HttpResponse<String> response = Unirest.post("https://httpbin.org/anything")
+  .header("content-type", "multipart/form-data; boundary=---011000010111000001101001")
+  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"foo\"; filename=\"hello.txt\"\r\nContent-Type: text/plain\r\n\r\n\r\n-----011000010111000001101001--\r\n")
+  .asString();

package/src/targets/java/unirest/fixtures/multipart-form-data-no-params.java

@@ -0,0 +1,3 @@
+HttpResponse<String> response = Unirest.post("https://httpbin.org/anything")
+  .header("Content-Type", "multipart/form-data")
+  .asString();

package/src/targets/java/unirest/fixtures/multipart-form-data.java

@@ -0,0 +1,4 @@
+HttpResponse<String> response = Unirest.post("https://httpbin.org/anything")
+  .header("Content-Type", "multipart/form-data; boundary=---011000010111000001101001")
+  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"foo\"\r\n\r\nbar\r\n-----011000010111000001101001--\r\n")
+  .asString();

package/src/targets/java/unirest/fixtures/nested.java

@@ -0,0 +1,2 @@
+HttpResponse<String> response = Unirest.get("https://httpbin.org/anything?foo%5Bbar%5D=baz%2Czap&fiz=buz&key=value")
+  .asString();

package/src/targets/java/unirest/fixtures/query-encoded.java

@@ -0,0 +1,2 @@
+HttpResponse<String> response = Unirest.get("https://httpbin.org/anything?startTime=2019-06-13T19%3A08%3A25.455Z&endTime=2015-09-15T14%3A00%3A12-04%3A00")
+  .asString();

package/src/targets/java/unirest/fixtures/query.java

@@ -0,0 +1,2 @@
+HttpResponse<String> response = Unirest.get("https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value")
+  .asString();

package/src/targets/java/unirest/fixtures/short.java

@@ -0,0 +1,2 @@
+HttpResponse<String> response = Unirest.get("https://httpbin.org/anything")
+  .asString();

package/src/targets/java/unirest/fixtures/text-plain.java

@@ -0,0 +1,4 @@
+HttpResponse<String> response = Unirest.post("https://httpbin.org/anything")
+  .header("content-type", "text/plain")
+  .body("Hello World")
+  .asString();

package/src/targets/javascript/axios/client.ts

@@ -0,0 +1,109 @@
+/**
+ * @description
+ * HTTP code snippet generator for Javascript & Node.js using Axios.
+ *
+ * @author
+ * @rohit-gohri
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+
+import type { Client } from '../../targets';
+import stringifyObject from 'stringify-object';
+
+import { CodeBuilder } from '../../../helpers/code-builder';
+
+export const axios: Client = {
+  info: {
+    key: 'axios',
+    title: 'Axios',
+    link: 'https://github.com/axios/axios',
+    description: 'Promise based HTTP client for the browser and node.js',
+  },
+  convert: ({ allHeaders, method, url, queryObj, postData }, options) => {
+    const opts = {
+      indent: '  ',
+      ...options,
+    };
+
+    const { blank, push, join, addPostProcessor } = new CodeBuilder({ indent: opts.indent });
+
+    push("import axios from 'axios';");
+    blank();
+
+    const requestOptions: Record<string, any> = {
+      method,
+      url,
+    };
+
+    if (Object.keys(queryObj).length) {
+      requestOptions.params = queryObj;
+    }
+
+    if (Object.keys(allHeaders).length) {
+      requestOptions.headers = allHeaders;
+    }
+
+    switch (postData.mimeType) {
+      case 'application/x-www-form-urlencoded':
+        if (postData.params) {
+          push('const encodedParams = new URLSearchParams();');
+          postData.params.forEach(param => {
+            push(`encodedParams.set('${param.name}', '${param.value}');`);
+          });
+
+          blank();
+
+          requestOptions.data = 'encodedParams,';
+          addPostProcessor(code => code.replace(/'encodedParams,'/, 'encodedParams,'));
+        }
+
+        break;
+
+      case 'application/json':
+        if (postData.jsonObj) {
+          requestOptions.data = postData.jsonObj;
+        }
+        break;
+
+      case 'multipart/form-data':
+        if (!postData.params) {
+          break;
+        }
+
+        push('const form = new FormData();');
+
+        postData.params.forEach(param => {
+          push(`form.append('${param.name}', '${param.value || param.fileName || ''}');`);
+        });
+
+        blank();
+
+        requestOptions.data = '[form]';
+        break;
+
+      default:
+        if (postData.text) {
+          requestOptions.data = postData.text;
+        }
+    }
+
+    const optionString = stringifyObject(requestOptions, {
+      indent: '  ',
+      inlineCharacterLimit: 80,
+    }).replace('"[form]"', 'form');
+    push(`const options = ${optionString};`);
+    blank();
+
+    push('axios');
+    push('.request(options)', 1);
+    push('.then(function (response) {', 1);
+    push('console.log(response.data);', 2);
+    push('})', 1);
+    push('.catch(function (error) {', 1);
+    push('console.error(error);', 2);
+    push('});', 1);
+
+    return join();
+  },
+};

package/src/targets/javascript/axios/fixtures/application-form-encoded.js

@@ -0,0 +1,21 @@
+import axios from 'axios';
+
+const encodedParams = new URLSearchParams();
+encodedParams.set('foo', 'bar');
+encodedParams.set('hello', 'world');
+
+const options = {
+  method: 'POST',
+  url: 'https://httpbin.org/anything',
+  headers: {'content-type': 'application/x-www-form-urlencoded'},
+  data: encodedParams,
+};
+
+axios
+  .request(options)
+  .then(function (response) {
+    console.log(response.data);
+  })
+  .catch(function (error) {
+    console.error(error);
+  });

package/src/targets/javascript/axios/fixtures/application-json.js

@@ -0,0 +1,24 @@
+import axios from 'axios';
+
+const options = {
+  method: 'POST',
+  url: 'https://httpbin.org/anything',
+  headers: {'content-type': 'application/json'},
+  data: {
+    number: 1,
+    string: 'f"oo',
+    arr: [1, 2, 3],
+    nested: {a: 'b'},
+    arr_mix: [1, 'a', {arr_mix_nested: {}}],
+    boolean: false
+  }
+};
+
+axios
+  .request(options)
+  .then(function (response) {
+    console.log(response.data);
+  })
+  .catch(function (error) {
+    console.error(error);
+  });

package/src/targets/javascript/axios/fixtures/cookies.js

@@ -0,0 +1,16 @@
+import axios from 'axios';
+
+const options = {
+  method: 'GET',
+  url: 'https://httpbin.org/cookies',
+  headers: {cookie: 'foo=bar; bar=baz'}
+};
+
+axios
+  .request(options)
+  .then(function (response) {
+    console.log(response.data);
+  })
+  .catch(function (error) {
+    console.error(error);
+  });

package/src/targets/javascript/axios/fixtures/custom-method.js

@@ -0,0 +1,12 @@
+import axios from 'axios';
+
+const options = {method: 'PROPFIND', url: 'https://httpbin.org/anything'};
+
+axios
+  .request(options)
+  .then(function (response) {
+    console.log(response.data);
+  })
+  .catch(function (error) {
+    console.error(error);
+  });

package/src/targets/javascript/axios/fixtures/full.js

@@ -0,0 +1,25 @@
+import axios from 'axios';
+
+const encodedParams = new URLSearchParams();
+encodedParams.set('foo', 'bar');
+
+const options = {
+  method: 'POST',
+  url: 'https://httpbin.org/anything',
+  params: {foo: ['bar', 'baz'], baz: 'abc', key: 'value'},
+  headers: {
+    cookie: 'foo=bar; bar=baz',
+    accept: 'application/json',
+    'content-type': 'application/x-www-form-urlencoded'
+  },
+  data: encodedParams,
+};
+
+axios
+  .request(options)
+  .then(function (response) {
+    console.log(response.data);
+  })
+  .catch(function (error) {
+    console.error(error);
+  });

package/src/targets/javascript/axios/fixtures/headers.js

@@ -0,0 +1,16 @@
+import axios from 'axios';
+
+const options = {
+  method: 'GET',
+  url: 'https://httpbin.org/headers',
+  headers: {accept: 'application/json', 'x-foo': 'Bar', 'x-bar': 'Foo'}
+};
+
+axios
+  .request(options)
+  .then(function (response) {
+    console.log(response.data);
+  })
+  .catch(function (error) {
+    console.error(error);
+  });

package/src/targets/javascript/axios/fixtures/http-insecure.js

@@ -0,0 +1,12 @@
+import axios from 'axios';
+
+const options = {method: 'GET', url: 'http://httpbin.org/anything'};
+
+axios
+  .request(options)
+  .then(function (response) {
+    console.log(response.data);
+  })
+  .catch(function (error) {
+    console.error(error);
+  });

package/src/targets/javascript/axios/fixtures/jsonObj-multiline.js

@@ -0,0 +1,17 @@
+import axios from 'axios';
+
+const options = {
+  method: 'POST',
+  url: 'https://httpbin.org/anything',
+  headers: {'content-type': 'application/json'},
+  data: {foo: 'bar'}
+};
+
+axios
+  .request(options)
+  .then(function (response) {
+    console.log(response.data);
+  })
+  .catch(function (error) {
+    console.error(error);
+  });

package/src/targets/javascript/axios/fixtures/jsonObj-null-value.js

@@ -0,0 +1,17 @@
+import axios from 'axios';
+
+const options = {
+  method: 'POST',
+  url: 'https://httpbin.org/anything',
+  headers: {'content-type': 'application/json'},
+  data: {foo: null}
+};
+
+axios
+  .request(options)
+  .then(function (response) {
+    console.log(response.data);
+  })
+  .catch(function (error) {
+    console.error(error);
+  });

package/src/targets/javascript/axios/fixtures/multipart-data.js

@@ -0,0 +1,21 @@
+import axios from 'axios';
+
+const form = new FormData();
+form.append('foo', 'Hello World');
+form.append('bar', 'Bonjour le monde');
+
+const options = {
+  method: 'POST',
+  url: 'https://httpbin.org/anything',
+  headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
+  data: '[form]'
+};
+
+axios
+  .request(options)
+  .then(function (response) {
+    console.log(response.data);
+  })
+  .catch(function (error) {
+    console.error(error);
+  });

package/src/targets/javascript/axios/fixtures/multipart-file.js

@@ -0,0 +1,20 @@
+import axios from 'axios';
+
+const form = new FormData();
+form.append('foo', 'src/fixtures/files/hello.txt');
+
+const options = {
+  method: 'POST',
+  url: 'https://httpbin.org/anything',
+  headers: {'content-type': 'multipart/form-data; boundary=---011000010111000001101001'},
+  data: '[form]'
+};
+
+axios
+  .request(options)
+  .then(function (response) {
+    console.log(response.data);
+  })
+  .catch(function (error) {
+    console.error(error);
+  });

package/src/targets/javascript/axios/fixtures/multipart-form-data-no-params.js

@@ -0,0 +1,16 @@
+import axios from 'axios';
+
+const options = {
+  method: 'POST',
+  url: 'https://httpbin.org/anything',
+  headers: {'Content-Type': 'multipart/form-data'}
+};
+
+axios
+  .request(options)
+  .then(function (response) {
+    console.log(response.data);
+  })
+  .catch(function (error) {
+    console.error(error);
+  });

package/src/targets/javascript/axios/fixtures/multipart-form-data.js

@@ -0,0 +1,20 @@
+import axios from 'axios';
+
+const form = new FormData();
+form.append('foo', 'bar');
+
+const options = {
+  method: 'POST',
+  url: 'https://httpbin.org/anything',
+  headers: {'Content-Type': 'multipart/form-data; boundary=---011000010111000001101001'},
+  data: '[form]'
+};
+
+axios
+  .request(options)
+  .then(function (response) {
+    console.log(response.data);
+  })
+  .catch(function (error) {
+    console.error(error);
+  });

package/src/targets/javascript/axios/fixtures/nested.js

@@ -0,0 +1,16 @@
+import axios from 'axios';
+
+const options = {
+  method: 'GET',
+  url: 'https://httpbin.org/anything',
+  params: {'foo[bar]': 'baz,zap', fiz: 'buz', key: 'value'}
+};
+
+axios
+  .request(options)
+  .then(function (response) {
+    console.log(response.data);
+  })
+  .catch(function (error) {
+    console.error(error);
+  });

package/src/targets/javascript/axios/fixtures/query-encoded.js

@@ -0,0 +1,19 @@
+import axios from 'axios';
+
+const options = {
+  method: 'GET',
+  url: 'https://httpbin.org/anything',
+  params: {
+    startTime: '2019-06-13T19%3A08%3A25.455Z',
+    endTime: '2015-09-15T14%3A00%3A12-04%3A00'
+  }
+};
+
+axios
+  .request(options)
+  .then(function (response) {
+    console.log(response.data);
+  })
+  .catch(function (error) {
+    console.error(error);
+  });

package/src/targets/javascript/axios/fixtures/query.js

@@ -0,0 +1,16 @@
+import axios from 'axios';
+
+const options = {
+  method: 'GET',
+  url: 'https://httpbin.org/anything',
+  params: {foo: ['bar', 'baz'], baz: 'abc', key: 'value'}
+};
+
+axios
+  .request(options)
+  .then(function (response) {
+    console.log(response.data);
+  })
+  .catch(function (error) {
+    console.error(error);
+  });

package/src/targets/javascript/axios/fixtures/short.js

@@ -0,0 +1,12 @@
+import axios from 'axios';
+
+const options = {method: 'GET', url: 'https://httpbin.org/anything'};
+
+axios
+  .request(options)
+  .then(function (response) {
+    console.log(response.data);
+  })
+  .catch(function (error) {
+    console.error(error);
+  });

package/src/targets/javascript/axios/fixtures/text-plain.js

@@ -0,0 +1,17 @@
+import axios from 'axios';
+
+const options = {
+  method: 'POST',
+  url: 'https://httpbin.org/anything',
+  headers: {'content-type': 'text/plain'},
+  data: 'Hello World'
+};
+
+axios
+  .request(options)
+  .then(function (response) {
+    console.log(response.data);
+  })
+  .catch(function (error) {
+    console.error(error);
+  });

package/src/targets/javascript/fetch/client.ts

@@ -0,0 +1,129 @@
+/**
+ * @description
+ * HTTP code snippet generator for fetch
+ *
+ * @author
+ * @pmdroid
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+
+import type { Client } from '../../targets';
+import stringifyObject from 'stringify-object';
+
+import { CodeBuilder } from '../../../helpers/code-builder';
+import { getHeaderName } from '../../../helpers/headers';
+
+interface FetchOptions {
+  credentials?: Record<string, string> | null;
+}
+
+export const fetch: Client<FetchOptions> = {
+  info: {
+    key: 'fetch',
+    title: 'fetch',
+    link: 'https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch',
+    description: 'Perform asynchronous HTTP requests with the Fetch API',
+  },
+  convert: ({ method, allHeaders, postData, fullUrl }, inputOpts) => {
+    const opts = {
+      indent: '  ',
+      credentials: null,
+      ...inputOpts,
+    };
+
+    const { blank, join, push } = new CodeBuilder({ indent: opts.indent });
+
+    const options: Record<string, any> = {
+      method,
+    };
+
+    if (Object.keys(allHeaders).length) {
+      options.headers = allHeaders;
+    }
+
+    if (opts.credentials !== null) {
+      options.credentials = opts.credentials;
+    }
+
+    switch (postData.mimeType) {
+      case 'application/x-www-form-urlencoded':
+        options.body = postData.paramsObj ? postData.paramsObj : postData.text;
+        break;
+
+      case 'application/json':
+        if (postData.jsonObj) {
+          // Though `fetch` doesn't accept JSON objects in the `body` option we're going to
+          // stringify it when we add this into the snippet further down.
+          options.body = postData.jsonObj;
+        }
+        break;
+
+      case 'multipart/form-data':
+        if (!postData.params) {
+          break;
+        }
+
+        // The FormData API automatically adds a `Content-Type` header for `multipart/form-data` content and if we add our own here data won't be correctly transmitted.
+        // eslint-disable-next-line no-case-declarations -- We're only using `contentTypeHeader` within this block.
+        const contentTypeHeader = getHeaderName(allHeaders, 'content-type');
+        if (contentTypeHeader) {
+          delete allHeaders[contentTypeHeader];
+        }
+
+        push('const form = new FormData();');
+
+        postData.params.forEach(param => {
+          push(`form.append('${param.name}', '${param.value || param.fileName || ''}');`);
+        });
+
+        blank();
+        break;
+
+      default:
+        if (postData.text) {
+          options.body = postData.text;
+        }
+    }
+
+    // If we ultimately don't have any headers to send then we shouldn't add an empty object into the request options.
+    if (options.headers && !Object.keys(options.headers).length) {
+      delete options.headers;
+    }
+
+    push(
+      `const options = ${stringifyObject(options, {
+        indent: opts.indent,
+        inlineCharacterLimit: 80,
+
+        // The Fetch API body only accepts string parameters, but stringified JSON can be difficult
+        // to read, so we keep the object as a literal and use this transform function to wrap the
+        // literal in a `JSON.stringify` call.
+        transform: (object, property, originalResult) => {
+          if (property === 'body') {
+            if (postData.mimeType === 'application/x-www-form-urlencoded') {
+              return `new URLSearchParams(${originalResult})`;
+            } else if (postData.mimeType === 'application/json') {
+              return `JSON.stringify(${originalResult})`;
+            }
+          }
+
+          return originalResult;
+        },
+      })};`
+    );
+    blank();
+
+    if (postData.params && postData.mimeType === 'multipart/form-data') {
+      push('options.body = form;');
+      blank();
+    }
+
+    push(`fetch('${fullUrl}', options)`);
+    push('.then(response => response.json())', 1);
+    push('.then(response => console.log(response))', 1);
+    push('.catch(err => console.error(err));', 1);
+
+    return join();
+  },
+};