https://github.com/imankii01/dynamic-api-wrapper
Dynamic API Wrapper is a lightweight and flexible API wrapper for Node.js, designed to make API integrations easier and more efficient. It supports GET, POST, PUT, DELETE, and PATCH requests while handling authentication, retries, and error management automatically.
https://github.com/imankii01/dynamic-api-wrapper
api backend nodejs nodejs-api opne-source rate-limiting wrapper
Last synced: about 1 month ago
JSON representation
Dynamic API Wrapper is a lightweight and flexible API wrapper for Node.js, designed to make API integrations easier and more efficient. It supports GET, POST, PUT, DELETE, and PATCH requests while handling authentication, retries, and error management automatically.
- Host: GitHub
- URL: https://github.com/imankii01/dynamic-api-wrapper
- Owner: imankii01
- Created: 2025-02-08T17:09:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-08T17:17:50.000Z (over 1 year ago)
- Last Synced: 2025-04-05T14:12:10.010Z (about 1 year ago)
- Topics: api, backend, nodejs, nodejs-api, opne-source, rate-limiting, wrapper
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/dynamic-api-wrapper
- Size: 6.84 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🚀 Dynamic API Wrapper
[](https://www.npmjs.com/package/dynamic-api-wrapper)
[](https://opensource.org/licenses/MIT)
A powerful, flexible, and easy-to-use API wrapper for **any REST API**.
Simplify API integrations in **Node.js** with built-in authentication, error handling, and rate limiting.
---
## **🌟 Features**
✅ Supports **GET, POST, PUT, DELETE, PATCH** requests
✅ Works with **any REST API**
✅ Supports **API Key & OAuth authentication**
✅ **Automatic retries** on failures & rate limits
✅ **Environment variable support** (for API keys)
✅ **Modular & Extensible**
✅ **TypeScript support** for better DX
---
## **📌 When to Use**
- Connecting to **external REST APIs** in a Node.js project
- Building **microservices** that require multiple API calls
- Simplifying **API integration** for internal and external services
- Handling **authentication, retries, and error handling** automatically
---
## **🛠️ How This API Wrapper Makes Your Work Easier**
Before using this wrapper, you might be making **raw API calls manually** using `axios` or `fetch`, leading to:
❌ **Repeated code** for handling API requests
❌ **Hardcoded authentication headers** everywhere
❌ **No error handling** for rate limits or failed requests
❌ **Difficult debugging & maintenance**
### **✅ How This Wrapper Helps**
🔹 **One-time setup** → Initialize the client once and reuse it
🔹 **Automatic authentication** → No need to manually add headers
🔹 **Built-in error handling** → Automatically retries rate-limited requests
🔹 **Less code, more efficiency** → Clean, readable API calls
🔹 **Consistent API design** → Same method for any REST API
### **📌 Example Before vs. After Using This Wrapper**
#### ❌ **Without This Wrapper (Traditional Approach)**
```js
const axios = require("axios");
async function getUser(userId) {
try {
const response = await axios.get(`https://api.example.com/users/${userId}`, {
headers: { Authorization: `Bearer ${process.env.API_KEY}` }
});
return response.data;
} catch (error) {
console.error("API Error:", error.message);
}
}
getUser("12345");
```
#### ✅ **With This Wrapper**
```js
const DynamicAPIWrapper = require("dynamic-api-wrapper");
const api = new DynamicAPIWrapper({
baseURL: "https://api.example.com",
apiKey: process.env.API_KEY,
});
async function getUser() {
try {
const user = await api.get("/users/12345");
console.log(user);
} catch (error) {
console.error("Error:", error.message);
}
}
getUser();
```
### **🎯 What's Different?**
✅ **No need to manually handle headers**
✅ **No need to handle errors manually**
✅ **Reusable client for multiple API calls**
✅ **Cleaner, more readable code**
---
## **📦 Installation**
Install via NPM:
```sh
npm install dynamic-api-wrapper
```
Or using Yarn:
```sh
yarn add dynamic-api-wrapper
```
---
## **🚀 Quick Start**
### **1️⃣ Import & Initialize**
```js
const DynamicAPIWrapper = require("dynamic-api-wrapper");
const api = new DynamicAPIWrapper({
baseURL: "https://api.example.com",
apiKey: process.env.API_KEY, // API Key from .env
});
```
### **2️⃣ Make API Requests**
#### ✅ **GET Request**
```js
async function fetchUser() {
try {
const user = await api.get("/users/12345");
console.log(user);
} catch (error) {
console.error("Error:", error.message);
}
}
fetchUser();
```
#### ✅ **POST Request**
```js
api.post("/users", { name: "John Doe" })
.then(response => console.log(response))
.catch(error => console.error(error));
```
#### ✅ **OAuth Support**
```js
const api = new DynamicAPIWrapper({
baseURL: "https://api.example.com",
token: process.env.OAUTH_TOKEN,
authType: "oauth",
});
```
---
## **⚙️ How It Works**
1. **Create an API client instance** with `baseURL` and authentication method.
2. **Make API calls** using `get()`, `post()`, `put()`, or `delete()`.
3. **Handles rate limits**, errors, and retries automatically.
✅ Uses **Axios** for requests
✅ Supports **OAuth and API Key-based authentication**
✅ Retries **429 (Rate Limit Exceeded) errors** automatically
---
## **🛠️ Configuration**
### **Using `.env` for API Keys**
Create a `.env` file and store your API credentials securely:
```
API_KEY=your_api_key_here
API_BASE_URL=https://api.example.com
```
Then, use it in your code:
```js
require("dotenv").config();
```
---
## **💡 Advanced Usage**
### **Custom Headers**
```js
api.get("/data", {}, { "Custom-Header": "value" });
```
### **Sending Query Parameters**
```js
api.get("/search", { query: "test", limit: 10 });
```
### **Handling Errors**
```js
try {
const response = await api.get("/users/12345");
} catch (error) {
console.error("API Error:", error.message);
}
```
---
## **📝 License**
This project is licensed under the **MIT License**.
[Read More](https://opensource.org/licenses/MIT)
---
## **👨💻 Author**
**Ankit** – Full Stack Developer
🔗 [LinkedIn](https://www.linkedin.com/in/imankii01)
🔗 [GitHub](https://github.com/imankii01)
🔗 [NPM Profile](https://www.npmjs.com/~private.ankit047)
☕ **Support My Work:**
[](https://www.buymeacoffee.com/imankii01)
---
## **💬 Contributing**
Contributions are welcome!
Feel free to submit **issues and pull requests** on GitHub.
Happy coding! 🚀