npmpackage.info

Gathering detailed insights and metrics for @deskree/postman-collection-generator

@deskree/postman-collection-generator - 1.1.2 | npmpackage.info

@deskree/postman-collection-generator

The following package generates postman collection from express controllers folder

1.1.2

MIT

TypeScript

31.66 kB

3.7

Installations

npm install @deskree/postman-collection-generator

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

16.20.1

NPM Version

8.19.4 Pull Requests

Open

0

Total

20

Closed

1

Merged

19

Issues

Open

0

Total

0

Closed

0

Releases

Version 1.1.2

1.1.2

Updated on Jul 27, 2023

Version 1.1.1

1.1.1

Updated on Apr 26, 2023

Version 1.1.0

1.1.0

Updated on Apr 26, 2023

Version 1.0.30

1.0.30

Updated on Apr 26, 2023

Version 1.0.29

1.0.29

Updated on Apr 26, 2023

Version 1.0.28

1.0.28

Updated on Mar 21, 2023

View All 33 releases

Languages

TypeScript

JavaScript

TypeScript (98.33%)

JavaScript (1.67%)

Developer

deskree-inc

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

5 Stars

88 Commits

5 Watchers

2 Branches

11 Contributors

Updated on Aug 15, 2024

Maintainers

View All 11 Contributors

Package Meta Information

Latest Version

1.1.2

Package Id

@deskree/postman-collection-generator@1.1.2

Unpacked Size

31.66 kB

Size

7.12 kB

File Count

NPM Version

8.19.4

Node Version

16.20.1

Published on

Jul 27, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

fs postman-collection yargs

Dev Dependencies

@types/node @types/jest @types/yargs @types/postman-collection @typescript-eslint/eslint-plugin eslint eslint-config-standard-with-typescript eslint-plugin-import eslint-plugin-n eslint-plugin-promise jest ts-jest typescript ts-node

postman-collection-generator

This package generates postman collection from express controllers.

Installing

Install package as a dev dependency via npm.

npm install --save @deskree/postman-collection-generator

Import package either into the base class of your controllers or to each controller individually:

import {PostmanControllerInterface} from "@deskree/postman-collection-generator";

Using

Controller Data Structure

postman-collection-generator creates postman collections from express controllers. In order for the collection and items to be generated correctly, each controller has to be a class that implements a PostmanControllerInterface and have the appropriate data structure. See example below:

// exampleController.ts
import {PostmanControllerInterface} from "@deskree/postman-collection-generator";

export class ExampleController implements PostmanControllerInterface {

    public name = 'Example Name of Postman Folder';
    public description = 'Example Description of Postman Folder';
    public routes = [
        {
            name: 'GET Something by id',
            url: '/example/{{id}}',
            method: 'GET',
            description: 'Get something from somewhere by some id',
            params: ['some_param=123'],
            headers: [{ key: 'Content-Type', value: 'application/json' }]
        },
        {
            name: 'Create Product',
            url: '/product',
            method: 'POST',
            body: {
                product: {
                    title: "Product Name",
                    price: 12,
                    tags: [
                        "Product"
                    ]
                }
            }
        }
    ]

    ...

Overall Data Structure

Parameter	Type	Required	Description
name	string	yes	Name of Postman folder (itemsGroup)
description	string	no	Description of Postman folder (itemsGroup)
routes	array	yes	List of Postman requests (items)

`routes` Data Structure

Parameter	Type	Required	Description
name	string	yes	Name of Postman request
description	string	no	Description of Postman request
url	string	yes	Postman request URL
method	string	yes	Postman request method (ex. GET, POST, PUT, DELETE)
params	array of strings	no	List of postman request parameters
headers	array of objects	no	List of postman request headers. Each header must have the following structure: { key: 'Some header key', value: 'some header value' }
body	object	no	Body of postman request

Configure `package.json`

In order to run postman-collection-generator, just add the following line into your package.json's "scripts" with appropriate parameters. Example:

...
"scripts": {
    "postman": "postman-generator --folder src/controllers --outputDir ./ --integrationName Example --baseURL https://user.deskree.com/api/v1"
}
...

Command parameters:

Parameter	Type	Required	Description
--folder	string	yes	Folder with your controllers
--outputDir	string	yes	Folder where you want to save the postman collection
--integrationName	string	yes	Name of your postman collection
--baseURL	string	yes	Base url for all requests within your collection

Run

Once everything is set up and package.json is configured, just run the following command to generate your Postman collection:

npm run postman

Output

The command will generate collection.json file in the specified folder. You can import this collection into Postman.

Built with

Authors

Deskree Team - deskree-inc
Gustavo Sanchez - antero10

License

This project is licensed under the MIT License

No vulnerabilities found.

10

Dangerous-Workflow

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

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.

6

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

5

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

2

Pinned-Dependencies

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

1

SAST

Determines if the project uses static code analysis.

0

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

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

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

Score

3.7

/10

Last Scanned on 2025-07-07

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

@deskree/postman-collection-generator

Installations

Developer Guide

Yes

CommonJS

16.20.1

8.19.4

Pull Requests

0

20

1

19

Issues

0

0

0

Releases

Languages

Developer

deskree-inc

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

postman-collection-generator

Installing

Using

Controller Data Structure

Overall Data Structure

routes Data Structure

Configure package.json

Run

Output

Built with

Authors

License

10

10

10

6

5

2

1

0

0

0

0

0

0

3.7

/10

`routes` Data Structure

Configure `package.json`