Motivation

Installation

npm i api-tools-ts

Importing

TypeScript

import{APIController}from"api-tools-ts";constapi=newAPIController(endpoint);// the main endpoint for the api you wish to create

JavaScript

const{ APIController}=require("api-tools-ts");constapi=newAPIController(endpoint);// the main endpoint for the api you wish to create

Example

Create an API with 2 different endpoints

import{APIController}from"api-tools-ts";constapi=newAPIController("/api/v1");api.AddEndPoint("/","get",(req,res)=>{res.status(200).json({home:"home is now accessible"});});api.AddEndPoint("/:random","get",(req,res)=>{constrandom=req.params.random;res.status(200).json({test:Math.round(Math.random()*Number(random))});});api.startServer({useDefaultMiddlewares:'true'});// to apply default middlewares ["cors", "morgan", "helmet"]

Add multiple methods to single endpoint

import{APIController}from"api-tools-ts";constapi=newAPIController("/api/v1");constpostUser=(req,res)=>{res.status(200).json({status:"ok",message:"User created successfully."});}constgetUsers=(req,res)=>{res.status(200).json({status:"ok",message:"Here are all users"});}constdeleteUser=(req,res)=>{res.status(200).json({status:"ok",message:"User deleted successfully"});}api.AddMultipleMethods("/users",["get","post","delete"],[getUsers,postUser,deleteUser]);api.startServer({useDefaultMiddlewares:'true'});

Add custom middlewares

api.AddEndPoint("/user","get",(req,res)=>{res.status(200).json({status:"ok",message:"Here are all users"});})api.AddMiddleWare("whatever",(req,res,next)=>{console.log("I am activated");next();})api.startServer({useDefaultMiddlewares:'true'});

API Server port is by default set to 51337. To change it, simply do:

api.port=<yourport>api.startServer({useDefaultMiddlewares:'true'});

Method startServer

api.startServer({useDefaultMiddlewares:'false'});