Nestjs Api To Postman Collection

What is Nestjs Api To Postman Collection?

Nestjs Api To Postman Collection is a Model Context Protocol (MCP) server that automatically converts NestJS controllers into importable Postman API collections. It eliminates manual collection creation or Swagger clutter by analyzing controller decorators and generating complete Postman JSON.

How to use Nestjs Api To Postman Collection?

Install dependencies, build the project, then configure your MCP‑compatible AI assistant (e.g., Claude Desktop, VS Code tools) with the command and path to dist/main.js. Alternatively, run the CLI directly: node dist/main.js generate <project-path> -o output.json. Example prompt: "Generate a Postman collection for my user.controller.ts file."

Key features of Nestjs Api To Postman Collection

• Automatically generates Postman collections from NestJS controllers
• Detects request/response types and creates meaningful examples
• Identifies authentication guards and adds auth configurations
• Captures routes, methods, request bodies, and query parameters
• Works without modifying your NestJS codebase
• Integrates with any MCP‑compatible AI assistant

Use cases of Nestjs Api To Postman Collection

• Quickly generate Postman collections for existing NestJS APIs
• Keep collections in sync as endpoints change
• Avoid cluttering code with Swagger/OpenAPI decorators
• Automate API documentation for testing and team sharing
• Streamline onboarding by providing ready‑to‑use collections

FAQ from Nestjs Api To Postman Collection

How does this differ from Swagger‑based Postman generation?

It works directly from NestJS controller code without requiring Swagger decorators, keeping your codebase clean. Collections are generated just in time rather than being built from a separate document.

What are the runtime requirements?

Node.js 16 or later and a NestJS project written in TypeScript with a tsconfig.json.

Where does the generated collection data live?

The output is a local JSON file (specified by the -o flag or saved by the AI assistant) that can be imported into Postman.

Does it modify my NestJS source code?

No. The tool reads controllers and decorators without adding any annotations or comments to your project.

What transport and authentication are supported?

It uses the MCP stdio transport (node subprocess). Authentication is handled by detecting NestJS guards and adding corresponding auth headers/parameters to the collection.