npmpackage.info

Gathering detailed insights and metrics for postman-code-generators

postman-code-generators

Common repository for all code generators shipped with Postman

1.14.0

996

Apache-2.0

JavaScript

337.55 kB

2,352,998 3.5

Installations

npm install postman-code-generators

Pull Requests

Open

25

Total

545

Closed

189

Merged

331

Issues

Open

78

Total

197

Closed

119

Releases

v1.14.0

Published on 10 Oct 2024

v1.13.0

Published on 11 Sept 2024

v1.12.0

Published on 22 Jul 2024

v1.11.0

Published on 10 Jul 2024

v1.10.1

Published on 06 May 2024

v1.10.0

Published on 02 May 2024

View all 17 releases

Developer

postmanlabs

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

>=12

Typescript Support

No

Node Version

12.0.0

NPM Version

6.9.0 Statistics

996 Stars

1,561 Commits

351 Forks

34 Watching

59 Branches

77 Contributors

Updated on 20 Nov 2024

Bundle Size

1.00 MB

Minified

337.55 kB

Minified + Gzipped

Bundlephobia

Languages

JavaScript (99.24%)

Shell (0.73%)

PHP (0.03%)

Total Downloads

Cumulative downloads

Total Downloads

2,352,998

Last day

-3.3%

3,222

Compared to previous day

Last week

4.4%

17,818

Compared to previous week

Last month

27.3%

94,365

Compared to previous month

Last year

208.8%

1,231,666

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Manage all of your organization's APIs in Postman, with the industry's most complete API development environment.

Supercharge your API workflow.
Modern software is built on APIs. Postman helps you develop APIs faster.

postman-code-generators

This module converts a Postman SDK Request Object into a code snippet of chosen language.

Every code generator has two identifiers: language and variant.

language of a code generator is the programming language in which the code snippet is generated.
variant of a code generator is the methodology or the underlying library used by the language to send requests.

List of supported code generators:

Language	Variant
C	libcurl
C#	HttpClient
C#	RestSharp
cURL	cURL
Dart	http
Go	Native
HTTP	HTTP
Java	OkHttp
Java	Unirest
JavaScript	Fetch
JavaScript	jQuery
JavaScript	XHR
Kotlin	OkHttp
NodeJs	Axios
NodeJs	Native
NodeJs	Request
NodeJs	Unirest
Objective-C	NSURLSession
OCaml	Cohttp
PHP	cURL
PHP	Guzzle
PHP	pecl_http
PHP	HTTP_Request2
PowerShell	RestMethod
Python	http.client
Python	Requests
R	httr
R	RCurl
Rust	Reqwest
Ruby	Net:HTTP
Shell	Httpie
Shell	wget
Swift	URLSession

[postman-code-generators

Getting Started

To install postman-code-generators as your dependency

1$ npm install postman-code-generators

To get a copy on your local machine

1$ git clone https://github.com/postmanlabs/postman-code-generators.git

Prerequisite

To run any of the postman-code-generators, ensure that you have NodeJS >= v8. A copy of the NodeJS installable can be downloaded from https://nodejs.org/en/download/package-manager.

Usage

Using postman-code-generators as a Library

There are three functions that are exposed in postman-code-generators: getLanguageList, getOptions, and convert.

getLanguageList

This function returns a list of supported code generators.

Example:

1var codegen = require('postman-code-generators'), // require postman-code-generators in your project
2    supportedCodegens = codegen.getLanguageList();
3    console.log(supportedCodegens);
4    // output:
5    // [
6    //   {
7    //     key: 'nodejs',
8    //     label: 'NodeJs',
9    //     syntax_mode: 'javascript',
10    //     variant: [
11    //       {
12    //         key: 'Requests'
13    //       },
14    //       {
15    //         key: 'Native'
16    //       },
17    //       {
18    //         key: 'Unirest'
19    //       }
20    //     ]
21    //   },
22    //   ...
23    // ]

getOptions

This function takes in three parameters and returns a callback with error and supported options of that code generator.

language - language key from the language list returned from getLanguageList function
variant - variant key provided by getLanguageList function
callback - callback function with first parameter as error and second parameter as array of options supported by the codegen.

A typical option has the following properties:

name - Display name
id - unique ID of the option
type - Data type of the option. (Allowed data types: boolean, enum, positiveInteger)
default - Default value. The value that is used if this option is not specified while creating code snippet
description - User friendly description.

Example:

1var codegen = require('postman-code-generators'), // require postman-code-generators in your project
2    language = 'nodejs',
3    variant = 'Request';
4
5    codegen.getOptions(language, variant, function (error, options) {
6      if (error) {
7        // handle error
8      }
9      console.log(options);
10    });
11// output: 
12//     [
13//     {
14//       name: 'Set indentation count',
15//       id: 'indentCount',
16//       type: 'positiveInteger',
17//       default: 2,
18//       description: 'Set the number of indentation characters to add per code level'
19//     },
20//     {
21//       name: 'Set indentation type',
22//       id: 'indentType',
23//       type: 'enum',
24//       availableOptions: ['Tab', 'Space'],
25//       default: 'Space',
26//       description: 'Select the character used to indent lines of code'
27//     },
28//     ...
29//   ];

convert

This function takes in five parameters and returns a callback with error and generated code snippet

language - lang key from the language list returned from getLanguageList function
variant - variant key provided by getLanguageList function
request - Postman-SDK Request Object
options - Options that can be used to configure generated code snippet. Defaults will be used for the unspecified attributes
callback - callback function with first parameter as error and second parameter as string for code snippet

Example:

1var codegen = require('postman-code-generators'), // require postman-code-generators in your project
2    sdk = require('postman-collection'), // require postman-collection in your project
3    request = new sdk.Request('https://www.google.com'),  //using postman sdk to create request 
4    language = 'nodejs',
5    variant = 'request',
6    options = {
7        indentCount: 3,
8        indentType: 'Space',
9        trimRequestBody: true,
10        followRedirect: true
11    };
12codegen.convert(language, variant, request, options, function(error, snippet) {
13    if (error) {
14        //  handle error
15    }
16    //  handle snippet
17});

Development

Installing dependencies

This command will install all the dependencies in production mode.

1$ npm install;

To install dev dependencies also for all codegens run:

1$ npm run deepinstall dev;

Testing

To run common repo test as well as tests (common structure test + individual codegen tests) for all the codegens

1$ npm test;

To run structure and individual tests on a single codegen

1$ npm test <codegen-name>;
2# Here "codege-name" is the folder name of the codegen inside codegens folder

Packaging

To create zipped package of all codegens

1$ npm run package;

Note: The zipped package is created inside each codegen's folder.

To create zipped package of a single codegen

1$ npm run package <codegen-name>

Contributing

Please take a moment to read our contributing guide to learn about our development process. Open an issue first to discuss potential changes/additions.

License

This software is licensed under Apache-2.0. Copyright Postman, Inc. See the LICENSE.md file for more information.

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

1

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 1

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/draft-new-release.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/postmanlabs/postman-code-generators/draft-new-release.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/draft-new-release.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/postmanlabs/postman-code-generators/draft-new-release.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/draft-new-release.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/postmanlabs/postman-code-generators/draft-new-release.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/draft-new-release.yml:66: update your workflow using https://app.stepsecurity.io/secureworkflow/postmanlabs/postman-code-generators/draft-new-release.yml/develop?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish-new-release.yml:38: update your workflow using https://app.stepsecurity.io/secureworkflow/postmanlabs/postman-code-generators/publish-new-release.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/postmanlabs/postman-code-generators/test.yml/develop?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/postmanlabs/postman-code-generators/test.yml/develop?enable=pin
Warn: downloadThenRun not pinned by hash: npm/ci-requirements.sh:130
Warn: npmCommand not pinned by hash: .github/workflows/test.yml:24
Info: 0 out of 3 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 4 third-party GitHubAction dependencies pinned
Info: 1 out of 1 nugetCommand dependencies pinned
Info: 0 out of 1 downloadThenRun dependencies pinned
Info: 0 out of 1 npmCommand dependencies pinned

0

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

45 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
Warn: Project is vulnerable to: GHSA-8hc4-vh64-cxmj
Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-6chw-6frg-f759
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-wg6g-ppvx-927h
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-2j2x-2gpw-g8fm
Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3
Warn: Project is vulnerable to: MAL-2023-462
Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5
Warn: Project is vulnerable to: GHSA-765h-qjxv-5f44
Warn: Project is vulnerable to: GHSA-f2jv-r9rf-7988
Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj
Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37
Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m / GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-g4rg-993r-mgx7
Warn: Project is vulnerable to: GHSA-mxhp-79qh-mcx6
Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9
Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw
Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc
Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh
Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh

Score

3.5

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to postman-code-generators

postman-code-generators

Installations

Pull Requests

25

545

189

331

Issues

78

197

119

Releases

Developer

postmanlabs

Developer Guide

CommonJS

>=12

No

12.0.0

6.9.0

Statistics

Bundle Size

1.00 MB

337.55 kB

Languages

Total Downloads

2,352,998

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

postman-code-generators

Table of contents

Getting Started

Prerequisite

Usage

Using postman-code-generators as a Library

getLanguageList

Example:

getOptions

Example:

convert

Example:

Development

Installing dependencies

Testing

Packaging

Contributing

License

10

10

10

10

1

0

0

0

0

0

0

0

3.5

/10

Other packages similar to postman-code-generators