retrieve

Author: aeltorio

.github/workflows/build.yml

@@ -0,0 +1,57 @@
+# Copyright 2024 Ronan LE MEILLAT
+# Licensed under the Affero GPL v3
+name: Build and Deploy
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+  packages: write
+  attestations: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '20'
+        registry-url: https://registry.npmjs.org/
+
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Build the project
+      run: npm run build
+
+    - name: Run tests
+      run: npm test
+
+    - name: Deploy to GitHub Pages
+      continue-on-error: true
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        git config --global user.name 'github-actions[bot]'
+        git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+        git add dist
+        git commit -m 'Update dist' dist/*
+        git push origin main
+
+    - name: Publish to npm
+      env:
+        NODE_AUTH_TOKEN: ${{secrets.NPMJS_TOKEN}}
+      run: npm publish
+      continue-on-error: true
+  

README.md

@@ -1,7 +1,7 @@
 # OpenAPI Snippet
 **Generates code snippets from Open API (previously Swagger) documents.**
 
-This package takes as input an OpenAPI v2.0 or v3.0.x document. It translates the document into an [HTTP Archive 1.2 request object](http://www.softwareishard.com/blog/har-12-spec/#request). It uses the [HTTP Snippet](https://github.com/Mashape/httpsnippet) library to generate code snippets for every API endpoint (URL path + HTTP method) defined in the specification in various languages & tools (`cURL`, `Node`, `Python`, `Ruby`, `Java`, `Go`, `C#`...), or for selected endpoints.
+This package takes as input an OpenAPI v2.0 or v3.0.x document. It translates the document into an [HTTP Archive 1.2 request object](http://www.softwareishard.com/blog/har-12-spec/#request). It uses the [HTTP Snippet](https://github.com/sctg-development/httpsnippet) library to generate code snippets for every API endpoint (URL path + HTTP method) defined in the specification in various languages & tools (`cURL`, `Node`, `Python`, `Ruby`, `Java`, `Go`, `C#`...), or for selected endpoints.
 
 ## Installation
 

index.js

@@ -8,8 +8,8 @@
  */
 'use strict';
 
-const OpenAPIToHar = require('./openapi-to-har.js');
-const HTTPSnippet = require('httpsnippet');
+import { getEndpoint, getAll } from './openapi-to-har.js';
+import { HTTPSnippet, availableTargets } from '@sctg/httpsnippet';
 
 /**
  * Return snippets for endpoint identified using path and method in the given
@@ -22,16 +22,17 @@ const HTTPSnippet = require('httpsnippet');
  *                          ['cURL', 'Node']
  * @param {object} values   Optional: Values for the query parameters if present
  */
-const getEndpointSnippets = function (openApi, path, method, targets, values) {
+export const getEndpointSnippets = function (openApi, path, method, targets, values) {
   // if optional parameter is not provided, set it to empty object
   if (typeof values === 'undefined') {
     values = {};
   }
 
-  const hars = OpenAPIToHar.getEndpoint(openApi, path, method, values);
+  const hars = getEndpoint(openApi, path, method, values);
 
   const snippets = [];
   for (const har of hars) {
+    // console.log(JSON.stringify(har, null, 4));
     const snippet = new HTTPSnippet(har);
     snippets.push(
       ...getSnippetsForTargets(
@@ -60,8 +61,8 @@ const getEndpointSnippets = function (openApi, path, method, targets, values) {
  * @param {array} targets   List of languages to create snippets in, e.g,
  *                          ['cURL', 'Node']
  */
-const getSnippets = function (openApi, targets) {
-  const endpointHarInfoList = OpenAPIToHar.getAll(openApi);
+export const getSnippets = function (openApi, targets) {
+  const endpointHarInfoList = getAll(openApi);
 
   const results = [];
   for (let i in endpointHarInfoList) {
@@ -147,7 +148,7 @@ const formatTarget = function (targetStr) {
   const title = capitalizeFirstLetter(language);
   let library = targetStr.split('_')[1];
 
-  const validTargets = HTTPSnippet.availableTargets();
+  const validTargets = availableTargets();
   let validLanguage = false;
   let validLibrary = false;
   for (let i in validTargets) {
@@ -190,18 +191,27 @@ const formatTarget = function (targetStr) {
  * @param snippet {Object}              Snippet object from httpsnippet to convert into the target objects
  * @param mimeType {string | undefined} Additional information to add uniqueness to the produced snippets
  */
-const getSnippetsForTargets = function (targets, snippet, mimeType) {
+export const getSnippetsForTargets = function (targets, snippet, mimeType) {
   const snippets = [];
+  let convertOptions = {};
   for (let j in targets) {
     const target = formatTarget(targets[j]);
     if (!target) throw new Error('Invalid target: ' + targets[j]);
+    // console.log(target.title);
+    if (target.title === 'Shell + Curl') {
+      convertOptions['short'] = true;
+    } else {
+      convertOptions = {};
+    }
+    // console.log(convertOptions);
     snippets.push({
       id: targets[j],
       ...(mimeType !== undefined && { mimeType: mimeType }),
       title: target.title,
       content: snippet.convert(
         target.language,
-        typeof target.library !== 'undefined' ? target.library : null
+        typeof target.library !== 'undefined' ? target.library : null,
+        convertOptions
       ),
     });
   }
@@ -212,23 +222,13 @@ const capitalizeFirstLetter = function (string) {
   return string.charAt(0).toUpperCase() + string.slice(1);
 };
 
-module.exports = {
+export const OpenAPISnippets = {
   getSnippets,
   getEndpointSnippets,
 };
 
 // The if is only for when this is run from the browser
 if (typeof window !== 'undefined') {
-  // grab existing namespace object, or create a blank object
-  // if it doesn't exist
-  let OpenAPISnippets = window.OpenAPISnippets || {};
-
-  // define that object
-  OpenAPISnippets = {
-    getSnippets,
-    getEndpointSnippets,
-  };
-
   // replace/create the global namespace
   window.OpenAPISnippets = OpenAPISnippets;
-}
+}

openapi-to-har.js

@@ -18,7 +18,7 @@
  *   "comment" : ""
  * }
  */
-const OpenAPISampler = require('openapi-sampler');
+import { sample as _sample } from 'openapi-sampler';
 
 /**
  * Create HAR Request object for path and method pair described in given OpenAPI
@@ -211,7 +211,7 @@ const objectJoin = function (
  *                              parameter is used to explicitly state which value should be used.
  * @return {HarParameterObject[]} - An array of query string objects
  */
-const createHarParameterObjects = function (
+export const createHarParameterObjects = function (
   { name, in: location, style, explode },
   value
 ) {
@@ -227,8 +227,8 @@ const createHarParameterObjects = function (
   }
 
   const objects = [];
-  style = style ?? getDefaultStyleForLocation(location);
-  explode = explode ?? getDefaultExplodeForStyle(style);
+  style = style || getDefaultStyleForLocation(location);
+  explode = explode || getDefaultExplodeForStyle(style);
 
   if (location === 'query' || location === 'cookie') {
     const separator = getArrayElementSeparator(style);
@@ -289,6 +289,52 @@ const createHarParameterObjects = function (
   return objects;
 };
 
+const formatSamples = function (sample) {
+  const params = [];
+
+  Object.keys(sample).map((key) => {
+    // console.log(`key=${JSON.stringify(key, null, 4)} (${typeof(sample[key])})`);
+    if (Array.isArray(sample[key])) {
+      // console.log("Array.isArray(sample[key])");
+      sample[key].forEach((entry) => {
+        // console.log(`entry=${JSON.stringify(entry, null, 4)}\n`);
+        params.push({
+          name: `${key}[]`,
+          value: entry,
+        });
+      });
+    } else if (Object.prototype.toString.call(sample[key]) === '[object Object]') {
+      // console.log("Object.prototype.toString.call(sample[key]) === '[object Object]'");
+      Object.keys(sample[key]).map((k) => {
+        // console.log(`k=${JSON.stringify(k, null, 4)}\n`);
+        if (Array.isArray(sample[key][k])) {
+          // console.log("Array.isArray(sample[key][k])");
+          sample[key][k].forEach((entry) => {
+            // console.log(`entry=${JSON.stringify(entry, null, 4)}\n`);
+            params.push({
+              name: `${key}[${k}][]`,
+              value: entry,
+            });
+          });
+        } else {
+          params.push({
+            name: key + '[' + k + ']',
+            value: sample[key][k],
+          });
+        }
+      });
+    } else {
+      // console.log("else\n");
+      params.push({
+        name: key,
+        value: sample[key],
+      });
+    }
+  });
+
+  return params;
+}
+
 /**
  * Get the payload definition for the given endpoint (path + method) from the
  * given OAI specification. References within the payload definition are
@@ -309,7 +355,7 @@ const getPayloads = function (openApi, path, method) {
         typeof param.schema !== 'undefined'
       ) {
         try {
-          const sample = OpenAPISampler.sample(
+          const sample = _sample(
             param.schema,
             { skipReadOnly: true },
             openApi
@@ -350,7 +396,8 @@ const getPayloads = function (openApi, path, method) {
     ].forEach((type) => {
       const content = openApi.paths[path][method].requestBody.content[type];
       if (content && content.schema) {
-        const sample = OpenAPISampler.sample(
+        // console.log(JSON.stringify(content, null, 4) + "\n");
+        const sample = _sample(
           content.schema,
           { skipReadOnly: true },
           openApi
@@ -378,13 +425,8 @@ const getPayloads = function (openApi, path, method) {
         } else if (type == 'application/x-www-form-urlencoded') {
           if (sample === undefined) return null;
 
-          const params = [];
-          Object.keys(sample).map((key) =>
-            params.push({
-              name: encodeURIComponent(key).replace(/\%20/g, '+'),
-              value: encodeURIComponent(sample[key]).replace(/\%20/g, '+'),
-            })
-          );
+          // console.log(`sample=${JSON.stringify(sample, null, 4)}`);
+          const params = formatSamples(sample);
 
           payloads.push({
             mimeType: 'application/x-www-form-urlencoded',
@@ -820,8 +862,5 @@ const resolveRef = function (openApi, ref) {
   return recursive(openApi, 1);
 };
 
-module.exports = {
-  getAll: openApiToHarList,
-  getEndpoint: createHar,
-  createHarParameterObjects,
-};
+export const getAll = openApiToHarList;
+export const getEndpoint = createHar;