api-collections-generator

0.1.3 • Public • Published

API Collection Generator

API Collection Generator is a tool for generating API collections from Swagger documentation.

This package is speically designed for NestJs Application.

Installation

To use the API Collection Generator, you can install it via npm:

Installation

npm install api-collections-generator

api-collections-generator

Example How To Use It Within Nestjs Main.ts

import GenerateAPICollection from "api-collections-generator";
const config = new DocumentBuilder()
  .setTitle("Your API")
  .setDescription("API description")
  .setVersion("1.0")
  .addBearerAuth()
  .build();

const document = SwaggerModule.createDocument(app, config);

SwaggerModule.setup("api", app, document);

const apiCollectionGenerator = new GenerateAPICollection(document);
apiCollectionGenerator.generateAPICollection();

Output

You will have a collection.json at your application base directory.

Package Sidebar

Install

npm i api-collections-generator

Weekly Downloads

0

Version

0.1.3

License

ISC

Unpacked Size

36.5 kB

Total Files

5

Last publish

Collaborators

  • piash.tanjin