Pigeon: Streamlining API Client Integration for NestJS Projects

Pigeon: Streamlining API Client Integration for NestJS Projects

In modern web development, efficient API management is crucial. Integrating APIs into client tools like Insomnia or Postman can be tedious, especially for large NestJS projects. Enter Pigeon, a CLI tool designed to simplify this process by automatically mapping all API routes into importable files for these clients.

Main Technologies Used

• Node.js: Pigeon is built on Node.js, ensuring cross-platform compatibility and performance.
• NestJS: Tailored specifically for NestJS applications, leveraging its decorators and structure.
• TypeScript: Developed in TypeScript for type safety and enhanced developer experience.

Key Features ✅

• Automatic Route Detection: Scans the entire NestJS project to detect all @Controller() routes.
• Organized Grouping: Groups routes by controller for clarity in API clients.
• Recursive Search: Recursively finds controllers throughout the project structure.
• Export Options: Exports mappings to insomnia.json or postman.json for easy import.
• Simple CLI Usage: Execute with a single command for quick results.
• Client Selection: Choose between Insomnia (default) and Postman, or exit the CLI with “Quit Pigeon”.

Development & Challenges

Developing Pigeon involved parsing NestJS project structures to accurately identify and map routes. Ensuring compatibility with both Insomnia and Postman formats required meticulous attention to their respective import schemas.

Project Access & Screenshots 📸

🔗 GitHub Repository https://github.com/Claquettes/pigeon

📦 NPM Package https://www.npmjs.com/package/pigeon-nest-mapper