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

nodejs-api-discovery

v1.2.5

Published

Nodejs API discovery CLI and postman collection generator

Downloads

27

Readme

Node.js API Endpoint Discovery and Postman Collection Generator

This Node.js npm package scans a directory for API endpoints implemented using Express framework, extracts endpoint details including headers, query parameters, and request body, and generates a Postman API collection file.

Installation

npm install nodejs-api-discovery

Requirements

  • Node.js version 18 or higher

Supported Frameworks

  • Express
  • Fastify
  • Sails
  • Nest

Usage

  1. Configuration

    Modify the config.json file to specify the directory to scan, the server framework (express for now), the object instance where endpoints are defined (app for Express), and other parameters.

    Mandatory fields are repoPath, framework & objectInstance only

    {
      "repoPath": "local directory path or remote repo url",
       "framework": "express",
       "objectInstance": "router",
       "baseUrl":"http::localhost:3000",
       "collectionName":" [optional]",
       "githubAPIKey":" [ Required only for private repos]",
       "workspaceId":"[ Required only for collection sync]",
       "postmanKey":" [ Required only for collection sync]",
       "postmanCollectionFile": "./postman_collection.json"
    }
    
  • githubAPIKey: Required only for Private Repo.

  • postmanKey: Required if you want to auto sync collection to postman workspace.

  • workspaceId: Required if you want to auto sync collection to postman workspace.

  1. Run tool Use the following command to run the tool with your configuration file:

    nodejs-api-discovery -c ./config.json
  2. Generated Postman Collection

    The generated Postman collection (postman_collection.json) contains API endpoints with methods, URLs prefixed by baseUrl, headers, query parameters, and request bodies (if available).

Next Steps

Future Improvements

  • Support for More Frameworks: Extend the tool to support other Node.js frameworks like Hapi, Koa, etc.

  • Enhanced Body Parsing: Improve body parsing logic to handle more complex body types (e.g., JSON, form-data, multipart).

  • Query Parameters: Currently supports basic query parameter extraction. Enhance to handle nested parameters and arrays.

  • Error Handling and Edge Cases: Add robust error handling for parsing failures and handle edge cases in route definition parsing.

Contributing

Contributions are welcome! Fork the repository, create a feature branch, and submit a pull request with your enhancements.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Notes:

  • This markdown section provides a clear and structured guide on how to install, configure, and use your npm package for discovering API endpoints and generating a Postman collection.
  • Adjust paths (index.mjs, config.json, etc.) and specific configurations (baseUrl, framework, etc.) according to your actual project setup and requirements.
  • Ensure to include this section in your README.md file in the root directory of your npm package to effectively communicate usage instructions to users and contributors.