7 months ago
A Model Context Protocol (MCP) tool that automatically converts your NestJS controllers into importable Postman API collections. This eliminates the need to manually create Postman collections or implement complex swagger documentation directly within your code.
Overview
What is NestJS API to Postman Collection?
NestJS API to Postman Collection is a tool that automatically converts NestJS controllers into importable Postman API collections, streamlining the process of API documentation and testing.
How to use NestJS API to Postman Collection?
To use this tool, clone the repository, install the dependencies, and configure it with your AI assistant or use the command line to generate a Postman collection directly from your NestJS project.
Key features of NestJS API to Postman Collection?
- 🚀 Automatic API Collection Generation: Converts NestJS controllers into Postman collections with a single command.
- 🔍 Intelligent Type Detection: Automatically detects request and response types to generate meaningful examples.
- 🔐 Auth Integration: Identifies authentication guards and adds appropriate auth configurations.
- 📊 Complete Endpoint Documentation: Captures routes, methods, request bodies, and query parameters.
- 🧩 Clean Integration: Works without modifying your NestJS codebase.
Use cases of NestJS API to Postman Collection?
- Automatically generating Postman collections for API testing.
- Keeping API documentation in sync with code changes.
- Simplifying the process of sharing API endpoints with team members.
FAQ from NestJS API to Postman Collection?
- Can this tool work with any NestJS project?
Yes! It is designed to work with any NestJS project that uses TypeScript.
- Is there a command line interface available?
Yes! You can use the command line to generate Postman collections directly.
- Does it require modifications to my existing code?
No, it works without modifying your NestJS codebase.
Server Config
{
"mcpServers": {
"Nest-Js-MCP-Postman-Generator": {
"command": "node",
"args": [
"<path_of_cloned_repo>/nestjs-mcp-generator/dist/main.js",
"start"
]
}
}
}