npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nestjs-postman

v1.0.15

Published

NestJS Postman Sync is a library that automatically synchronizes your NestJS controller routes with a Postman collection. This makes API testing easier during development by keeping your Postman collection up-to-date with your NestJS routes.

Downloads

30

Readme

NestJS Postman Sync

NestJS Postman Sync is a library that automatically synchronizes your NestJS controller routes with a Postman collection. This makes API testing easier during development by keeping your Postman collection up-to-date with your NestJS routes.

Installation

npm install nestjs-postman

Usage

  1. Import the NestjsPostmanModule in your app.module.ts:
import { NestjsPostmanModule } from "nestjs-postman";

@Module({
  imports: [
    NestjsPostmanModule.forRoot({
      apiKey: "your-postman-api-key",
      collectionId: "your-collection-id",
    }),
    // ... other imports
  ],
})
export class AppModule {}
  1. Use the @SyncWithPostman() decorator on controllers you want to sync:
import { Controller, Get } from "@nestjs/common";
import { SyncWithPostman } from "nestjs-postman";

@Controller("users")
@SyncWithPostman()
export class UsersController {
  @Get()
  findAll() {
    return "This route will be synced with Postman";
  }
}

Configuration

The NestjsPostmanModule.forRoot() method accepts a configuration object with the following properties:

  • apiKey: Your Postman API key
  • collectionId: The ID of the Postman collection you want to sync with
  • baseUrl (optional): The base URL for your API endpoints

How it works

When your NestJS application starts, the library scans all controllers decorated with @SyncWithPostman(). It then updates the specified Postman collection with the routes found in these controllers.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.