api-box-dex

API-BOX

API-BOX is a lightweight Node.js package that simplifies the process of creating RESTful APIs with pre-configured routes and database integration. It provides a set of pre-built routes for common CRUD operations (Create, Read, Update, Delete), making it easy for developers to set up APIs without writing repetitive code.

Features

• Pre-configured routes for CRUD operations
• Database integration with customizable models
• Easy setup and integration with Express.js
• Error handling and validation support
• Middleware support for authentication and authorization (coming soon)

Installation

Install api-box-dex with npm

  npm install api-box-dex

Usage/Examples

Setting up the Express app

const express = require("express");
const bodyParser = require("body-parser");
const { api } = require("api-box-dex");

Create an instance of the Express application:

const app = express();

Use middleware to parse request bodies:

app.use(bodyParser.json());

Using the API routes

Mount the API routes provided by API-BOX under the '/api' path:

app.use("/api", api);

Starting the server

Start the Express server:

const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

API Reference

API-BOX provides the following pre-configured routes for CRUD operations:

Get all items

  GET /api/items

Get item by ID

  GET /api/items/:id

Create a new item

  POST /api/items

Update an item by ID

  PUT /api/items/:id

Delete an item by ID

  DELETE /api/items/:id

Contributing

Contributions are always welcome!

You can customize the behavior of API-BOX by extending the provided models or by adding middleware to the Express app.

License

API-BOX is licensed under the MIT License. See the LICENSE file for details.