Getting Started

Getting Started

Welcome to the Generic SQL API Framework!

This guide will help you get the framework running in just a few minutes.

---

Requirements

Before you begin, ensure you have the following installed:

• PHP 8.1 or later
• Microsoft SQL Server
• ODBC Driver for SQL Server
• Web Server (Apache/XAMPP, IIS, or Nginx)
• Git (Optional)

---

Installation

Clone the repository:

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

Navigate to the project:

cd Generic_SQL_API_Framework

---

Configure Database

Edit the database configuration file:

config/database.json

Example:

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

---

Start the Server

If using XAMPP:

1. Start Apache.
2. Copy the project into the htdocs directory.
3. Open your browser.

http://localhost/Generic_SQL_API_Framework/

---

Verify Installation

Open the API endpoint:

/api/database/info

A successful response returns:

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

---

Next Steps

• Configure your SQL queries.
• Learn the JSON request format.
• Build your first API.
• Explore the documentation.

Continue with Quick Start to create your first API.