nodejs-rest-api-mysql

A node.js API server for MySQL - It can perform CRUD (Create, Read, Update, Delete) operations using HTTP Methods (POST, GET, PUT, and DELETE) for RESTful Services.

• RESTful
• Basic API Authentication
• SQL Injection cleaning
• Pagination Support
• Easy to setup

Configure

config.port = 3000;

//Authentication
config.auth = false;

//Database
config.database = 'database';
config.username = 'username';
config.password = 'password';
config.table_prefix = '';

//Pagination
config.paginate = true;
config.page_limit = 10;

• auth when true, enables HTTP Basic Authentication for the API. The username and password is stores in a file keys.htpasswd, which is in the format username:password
• Enter the database name, username and password for connecting to local mysql. Also, enter table prefix, if any.
• paginate when true, enables pagination support in get request, and you can set the limit per page in page_limit

Create (POST)

Create a new entry in the table with the parameters that are posted.

POST http://www.example.com/api/table_name

Response

• If the row is created :

{
  "success": 1,
  "id": inserted_id
}

• If parameters are missing :

{
  "success": 0,
  "message": "Parameters missing"
}

Read (GET)

Reads data from table.

• Read Entire Table

GET http://www.example.com/api/table_name

• Read by ID

GET http://www.example.com/api/table_name/id

Response

• If data exsists :

{
  "success": 1,
  "data": "..."
}

• If data missing :

{
  "success": 0,
  "message": "No rows found"
}

Update (PUT)

Update an entry in the table with the parameters that are put.

PUT http://www.example.com/api/table_name/id

Response

• If the row is updated :

{
  "success": 1,
  "message": "Updated"
}

• If parameters are missing :

{
  "success": 0,
  "message": "Parameters missing"
}

Delete (DELETE)

Delete an entry in the table.

DELETE http://www.example.com/api/table_name/id

Response

• If the row is deleted :

{
  "success": 1,
  "message": "Deleted"
}

Pending Features

• Security Features
• Find by field
• and more! :)