Skip to content

Installation

Jump to bottom
Shashank Patil edited this page Jul 26, 2026 · 1 revision

Installation

This guide explains how to install and configure the Generic SQL API Framework.

System Requirements

Before installing the framework, ensure your system meets the following requirements.

Operating System

  • Windows 10 / 11
  • Windows Server 2019+
  • Linux (Experimental)

PHP

  • PHP 8.1 or later

Verify your installation:

php -v

Database

Currently supported:

  • Microsoft SQL Server

Future support:

  • MySQL
  • PostgreSQL
  • MariaDB

ODBC Driver

Install the latest Microsoft ODBC Driver for SQL Server.

Verify the driver is installed before configuring the framework.

Web Server

Supported web servers:

  • Apache (Recommended)
  • IIS
  • Nginx

For beginners, XAMPP is the easiest option.

Download

Clone the repository.

git clone https://github.com/itsshashanksp/Generic_SQL_API_Framework.git

Move into the project directory.

cd Generic_SQL_API_Framework

Project Structure

Generic_SQL_API_Framework/

├── api/
├── config/
├── queries/
├── docs/
├── logs/
├── public/
├── assets/
└── index.php

Configure the Database

Open:

config/database.json

Example configuration:

{
    "server": "localhost\\SQLEXPRESS",
    "database": "AdventureWorks",
    "username": "sa",
    "password": "YourPassword"
}

Deploy

Copy the project into your web server.

Example using XAMPP:

C:\xampp\htdocs\

Start:

  • Apache
  • SQL Server

Open:

http://localhost/Generic_SQL_API_Framework/

Verify Installation

Open the API endpoint.

/api/database/info

Expected response:

{
    "success": true,
    "database": "AdventureWorks",
    "server": "localhost\\SQLEXPRESS"
}

Troubleshooting

SQL Connection Failed

  • Verify SQL Server is running.
  • Verify the ODBC Driver is installed.
  • Verify database credentials.

HTTP 500

  • Enable PHP error reporting.
  • Check the application logs.

Query Not Found

Ensure the SQL file exists inside the queries directory.

Next Steps

Congratulations! The framework is now installed.

Continue with:

  • Database Configuration
  • Your First API
  • JSON Request Format

Clone this wiki locally