MaskAPI

MaskAPI is a lightweight and secure Node.js package to register and proxy APIs via masked URLs, keeping your original API hidden and secure.
It is built with Node.js, TypeScript, and Axios, and works seamlessly with any backend.

🚀 Features

• Register any API endpoint and get a masked URL.
• Supports GET, POST, PUT, DELETE and other HTTP methods.
• Optionally send headers and request body.
• Easy to use with static methods, no need to instantiate the class.

📦 Installation

npm install maskapi-client

or

yarn add maskapi-client

⚡ Usage

import  MaskAPIClient  from "maskapi-client";

  // Register an API to get a masked URL
  const response = await MaskAPIClient.registerAPI({
      method: "GET",
      url: "https://secureapi.com",
    });
  console.log("Masked URL:", response);

  // You can now call the masked URL in your application

📄 API

MaskAPIClient.registerAPI(method, url, body?, headers?)

| Parameter | Type                | Description                        |
| --------- | ------------------- | ---------------------------------- |
| `method`  | `string`            | HTTP method (`GET`, `POST`, etc.)  |
| `url`     | `string`            | Original API URL to mask           |
| `body`    | `any` (optional)    | Request body for POST/PUT requests |
| `headers` | `object` (optional) | Headers to send with the request   |

🛠 Requirements

Node.js >= 18

npm >= 9 (or yarn)

📌 Notes

Masked URLs are generated by your proxy server. This package does not require instantiation; all methods are static. Use the masked URL to safely call your API without exposing the original endpoint.

🔗 License

If you want, I can also add a small diagram and workflow illustration showing how MaskAPI registers an API, returns a masked URL, and proxies requests. This makes the README even more beginner-friendly.

Do you want me to add that?