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

apman

v1.3.2

Published

Postman-based API client generator with Axios and joi

Downloads

440

Readme

ApMan

ApMan (API Manager) is a dynamic API client generator based on Postman Collections. It automatically creates methods for API requests, handles input validation using Joi, and integrates seamlessly with Axios for HTTP requests. npm GitHub npm GitHub issues GitHub Repo stars GitHub code size in bytes Platform GitHub contributors


Features

  • 🚀 Automatic API Method Generation: Generates methods dynamically based on Postman folder and request names.
  • 🌐 Base URL Support: Easily set a global base URL for all requests.
  • 📄 Supports formdata and urlencoded: Automatically parses request body inputs.
  • Input Validation: Ensures valid input using Joi before sending requests.

Installation

Install ApMan using npm, Yarn, or Bun:

npm

npm install apman

Yarn

yarn add apman

Bun

bun add apman

Setup

To use ApMan, export your Postman collection as a JSON file:

  1. Open Postman.
  2. Select your collection.
  3. Click "Export" > "Collection v2.1".

Usage

Importing and Initializing ApMan

// Import ApMan
const ApMan = require("./index");

// Import your json from postman
const json = require("./test/sample.json");

const api = new ApMan(json, {
  base_url: "example.com",
});

// List Available methods
console.log(apMan.methods);

// Example: Login, then use token to list all users
api
  .call("iamAuthLogin", {
    body: { rut: "25535866", password: "ut56gcmqk1btnjuu" },
  })
  .then((res) => {
    //Set Headers
    api.addHeader("Authorization", `Bearer ${res.accessToken}`);
    api.call("iamUserListAll", {}).then((res) => {
      console.log(res);
    });
  });

// You can use direct method calls too:
api.iamAuthLogin({ body: { rut: "25535866", password: "ut56gcmqk1btnjuu" } headers: {} });

// but don't forget to pass the headers when calling methods this way
api.iamUserListAll({ headers: api._headers });

// If you want to clear your headers you can use:
api.clearHeaders();

How It Works

  1. Base URL:

    • Set a global baseUrl during initialization.
    • All requests will use this as the prefix for their paths.

    Example:

    const api = new ApMan(json, {
      base_url: "miurl.com",
    });
  2. Dynamic Methods:

    • Methods are generated based on the folder and request names in the Postman JSON.
    • Names are converted to camelCase for easy use.

    Postman Example:

    • Folder: User
    • Request: Get User
    • Generated Method: userGetUser
  3. Input Validation:

    • For POST requests, ApMan automatically validates required inputs (e.g., formdata keys) using Joi.

    Example Validation:

    api.call("userCreateUser", { body: { username: "JohnDoe" } });
    // Throws: "Validation Error: "email" is required"

Example JSON

There is a sample.json file inside the /test folder. You can import it with:

const json = require("apman/test/sample.json");

License

MIT

Contributing

Feel free to open issues or submit pull requests for improvements and bug fixes.

Contact

For any questions or support, reach out to: