Initial push of codegen for Mikrotik RouterOS - `routeros-fetch` by mobileskyfi · Pull Request #770 · postmanlabs/postman-code-generators

mobileskyfi · 2024-09-23T00:04:28Z

New codegen for Mikrotik's RouterOS /tool/fetch command, in Postman terms named routeros-fetch. The command is used on any Mikrotik router to run web services. But RouterOS syntax is not the easiest since it requires specific escaping. So this "snippet" will deal with mapping a Postman Request, with the right string encoding. Error and tips are presented as RouterOS comments in the snippet. Two new options are added commentary to control if errors/tips are shown & style to control to specific form of the command as it can be used interactively or as a variable in a larger script.

Code was created using "npm boilerplate", with code/structure borrowed from http codegen since RouterOS requires similar "raw-like" bodies. Added "test-unit" that verify the RouterOS codegen offline, similar to the http file codegen unit tests.

The Newman tests do run successfully, except they require MikroTik RouterOS device running with SSH enabled to test (see codegen/routeros-fetch. I ran these manually.

See Issue #769 - Codegen push for Mikrotik RouterOS's /tool/fetch CLI command (routeros-fetch)

including newman (requires setup) and unit tests.

mobileskyfi · 2024-10-01T18:38:26Z

Any update here?

…improve first convert speed; added known issues to page

…erator for multiple headers)

potential difference in nodejs version?

…mmas

The curl2rsc tool moved to the main tikoci.github.io site as a proper browser-side SPA. Redirect the old postman-code-generators Pages URL to the new location, forwarding any ?cmd=... and ?style=... query params. - meta refresh + JS replace() for instant redirect - canonical URL points to new location (SEO) - README tip updated to reference new URL Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Adds a new Postman code generator for MikroTik RouterOS /tool/fetch (“routeros-fetch”), including unit tests and language labeling, plus additional repo-level website/CI workflow changes.

Changes:

Introduces codegens/routeros-fetch with conversion logic, options (style, commentary), and test suites/resources.
Registers RouterOS in language labels.
Adds GitHub Pages-related content (index.html, static.yml) and modifies CI workflow triggers.

Reviewed changes

Copilot reviewed 36 out of 37 changed files in this pull request and generated 14 comments.

Show a summary per file

File	Description
test/codegen/structure.test.js	Updates structure expectations/validations for codegen option IDs and `.eslintrc` presence.
package.json	Bumps root package version.
lib/assets/languageLabels.json	Adds `routeros` label mapping.
index.html	Adds a static page (redirect + UI) for curl-to-RouterOS conversion.
codegens/routeros-fetch/package.json	Defines new codegen package metadata.
codegens/routeros-fetch/index.js	Exposes the codegen module entrypoint.
codegens/routeros-fetch/lib/index.js	Implements RouterOS `/tool/fetch` snippet generation and options.
codegens/routeros-fetch/lib/utils.js	Adds RouterOS escaping/body/header utilities.
codegens/routeros-fetch/lib/lodash.js	Provides local lodash helpers (copied pattern).
codegens/routeros-fetch/.eslintrc	Adds ESLint configuration for the new codegen.
codegens/routeros-fetch/.gitignore	Adds ignore rules for the new codegen.
codegens/routeros-fetch/.npmignore	Adds npm ignore rules for the new codegen.
codegens/routeros-fetch/npm/test.js	Adds codegen test runner (lint + unit).
codegens/routeros-fetch/npm/test-lint.js	Adds ESLint runner script.
codegens/routeros-fetch/npm/test-unit.js	Adds Mocha+NYC unit test runner script.
codegens/routeros-fetch/npm/test-newman.js	Adds Mocha+NYC newman test runner script.
codegens/routeros-fetch/npm-shrinkwrap.json	Adds shrinkwrap for the new codegen package.
codegens/routeros-fetch/README.md	Documents the new codegen (currently boilerplate).
codegens/routeros-fetch/routeros-fetch-cmd	Adds a RouterOS snippet file (likely for newman usage).
codegens/routeros-fetch/test/unit/package.test.js	Adds package metadata validation tests.
codegens/routeros-fetch/test/unit/converter.test.js	Adds conversion behavior unit tests.
codegens/routeros-fetch/test/resources/test-collection.json	Adds fixture collection for unit tests.
codegens/routeros-fetch/test/resources/expected-http-messages.json	Adds expected output fixtures for unit tests.
codegens/routeros-fetch/test/resources/error-collection.json	Adds error-case fixtures for unit tests.
codegens/routeros-fetch/test/newman/newman.test.js	Adds newman-based integration tests scaffold.
codegens/routeros-fetch/test/newman/fixtures/basicCollection.json	Adds newman fixtures for routeros-fetch.
codegens/routeros-fetch/test/newman/fixtures/rawBody.json	Adds newman fixtures for routeros-fetch.
codegens/routeros-fetch/test/newman/fixtures/formdataCollection.json	Adds newman fixtures for routeros-fetch.
codegens/routeros-fetch/test/newman/fixtures/emptyFormdataCollection.json	Adds newman fixtures for routeros-fetch.
codegens/routeros-fetch/test/newman/fixtures/formdataFileCollection.json	Adds newman fixtures for routeros-fetch.
codegens/routeros-fetch/test/newman/fixtures/queryParamsCollection.json	Adds newman fixtures for routeros-fetch.
codegens/routeros-fetch/test/newman/fixtures/redirectCollection.json	Adds newman fixtures for routeros-fetch.
codegens/routeros-fetch/test/newman/fixtures/sameNameHeadersCollection.json	Adds newman fixtures for routeros-fetch.
codegens/routeros-fetch/test/newman/fixtures/unsupportedMethods.json	Adds newman fixtures for routeros-fetch.
README.md	Adds fork/site references at repo root.
.github/workflows/test.yml	Modifies CI workflow triggers.
.github/workflows/static.yml	Adds a GitHub Pages deployment workflow.

Files not reviewed (1)

codegens/routeros-fetch/npm-shrinkwrap.json: Language not supported

Comments suppressed due to low confidence (1)

test/codegen/structure.test.js:282

Enabling the .eslintrc existence check for every codegen will fail for many existing codegens that don't ship an .eslintrc (e.g. codegens/curl). Please revert this back to describe.skip(...), or gate the check so it only applies to codegens that are expected to have an .eslintrc.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+## Using the Module
+The module will expose an object which will have property `convert` which is the function for converting the Postman-SDK request to swift code snippet.
+
+### convert function
+Convert function takes three parameters
+
+* `request` - Postman-SDK Request Object
+
+* `options` - options is an object which hsa following properties
+    * `indentType` - String denoting type of indentation for code snippet. eg: 'Space', 'Tab'
+    * `indentCount` - The number of indentation characters to add per code level
+    * `trimRequestBody` - Whether or not request body fields should be trimmed


+> [!TIP]
+> ### For `curl` to `/tool/fetch` conversion, see this repo's webpage:
+> #### https://tikoci.github.io/curl2rsc.html
+> Source code lives at: https://github.com/tikoci/postman-code-generators/blob/develop/index.html
+
+> [!IMPORTANT]
+> ### Fork of `postman-code-generators`
+> #### Supporting Mikrotik RouterOS `/tool/fetch`
+> The Mikrotik RouterOS codegen is named `routeros-fetch` in Postman's _lang_-_library_ scheme.
+> This forks code support RouterOS is largely within: https://github.com/tikoci/postman-code-generators/tree/develop/codegens/routeros-fetch
+


+            #selectfetchoutput[value=""] {
+                display: node;
+            }


+  "author": "Postman Labs <help@getpostman.com>",
+  "license": "Apache-2.0",
+  "homepage": "https://github.com/postmanlabs/code-generators/tree/master/codegens/routeros-fetch",
+  "dependencies": {},


 {
  "name": "postman-code-generators",
-  "version": "1.13.0",
+  "version": "1.13.2",
  "description": "Generates code snippets for a postman collection",


+ * Used in order to get additional options for generation of C# code snippet (i.e. Include Boilerplate code)
+ *
+ * @module getOptions
+ *
+ * @returns {Array} Additional options specific to generation of http code snippet


+            <div hx-post="https://curl2rsc.glitch.me/curl" hx-target="#tafetchcmd" hx-swap="innerHTML" hx-include="this"
+                hx-trigger="change">
+                <fieldset id="curl2rscfields">
+                    <label>
+                        <code>curl</code>
+                        command line to convert from:
+                        <input name="cmd" hx-post="https://curl2rsc.glitch.me/curl" hx-target="#tafetchcmd"
+                            hx-swap="innerHTML" hx-trigger="keyup changed delay:2s" id="inputcurl" required


+          # Upload entire repository
+          path: '.'


+        const pasteClipboadText = (id) => {
+            navigator.clipboard.readText().then((clipText) =>
+                document.getElementById(id).value = clipText).error((error) => {
+                    console.error(error.message);
+                })


+  // var urlnoauth = Url.parse(request.url.toString(true));
+  request.url.auth = null;
+  if (request.url.getHost().startsWith('http')) {
+    const invalidHost = new Url(request.url.getHost());
+    request.url.host = invalidHost.getHost();
+    request.url.protocol = invalidHost.protocol;
+  }
+  attrs.set('url', utils.escapeRouterOSString(request.url.toString(true)));


Anthony Shaffer and others added 14 commits September 22, 2024 16:52

Initial checkin with Mikrotik RouterOS codegen for Postman

1011562

including newman (requires setup) and unit tests.

Add GH Pages for repo

fadac7b

initial index page to convert curl to routeros, via postman

26c0821

remove nacent ci from this fork

5485310

made "test" workflow a workflow_dispatch in ci to avoid building

4d6c398

use correct url in index.html

ff30040

add hx-request='{"noHeaders": true}' for cors

2aa0376

set htmx to allow FQDN/cors

4d19e01

set meta setting before htmx loads + use change event for dropdown

cc1f6a2

set htmx.config.selfRequestsOnly = false explictly

174af70

wait for dom; minor formatting

bd01a92

fix wttr.in to be valid, for wttr.in ;)

21c094b

update favicon

5d7c2cc

Merge branch 'postmanlabs:develop' into develop

c0c5975

mobileskyfi and others added 15 commits October 1, 2024 12:24

add "pre" fetch call on load to warmup glitch & [hopefully/slightly] …

f926d7f

…improve first convert speed; added known issues to page

moved known issues below the curl convert form

ed90087

use <header> for known issues in html

9fbfd41

first pass at "waiting" to give some feedback on htmx request

c876e6c

make just the text edit wait

edb273e

instead, use new div to communicate in-flight requests

746aecf

show errors

2a29d00

error text is not too useful...removing

11ff4f6

add note about fork to readme

dd9d791

add note where to find curl2rsc

2db0e3d

add link to readme with index.html

fd88170

remove paste, add warning about passwords

0919bf9

fix for escaping commas in headers value (since comma is RouterOS sep…

8808c05

…erator for multiple headers)

fix bug in "header comma" (JS is \\\\ for double backslash)

c10fd37

added test + fix in fix for header commas

83275af

SkyFi Geek and others added 10 commits November 8, 2024 09:17

always escape commas

f48a816

use toString() in header fix for nodejs context

03ff695

potential difference in nodejs version?

improve unit test; use regex global instead of replaceAll()

4a66b7d

fix formating of comma warning

012d974

update version

de28182

add unit test, apparently \\ is only required for one element with co…

5de67f8

…mmas

update homepage after glitch shutdown

d747aee

adjust html on retirment of web frontend

4cf193a

more html fixes

f9a51fb

Copilot AI review requested due to automatic review settings April 14, 2026 19:28

Copilot started reviewing on behalf of mobileskyfi April 14, 2026 19:29 View session

Copilot AI reviewed Apr 14, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial push of codegen for Mikrotik RouterOS - `routeros-fetch`#770

Initial push of codegen for Mikrotik RouterOS - `routeros-fetch`#770
mobileskyfi wants to merge 39 commits intopostmanlabs:developfrom
tikoci:develop

mobileskyfi commented Sep 23, 2024 •

edited

Loading

Uh oh!

mobileskyfi commented Oct 1, 2024

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

mobileskyfi commented Sep 23, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mobileskyfi commented Oct 1, 2024

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mobileskyfi commented Sep 23, 2024 •

edited

Loading