README

Darest - Auto-generated REST API from your database schema

Darest (Delphi Auto REST) is a powerful application that automatically exposes database tables as RESTful API endpoints using FireDAC and the Horse framework. With integrated Swagger/OpenAPI documentation, Darest makes it easy to create, configure, and deploy database-backed REST APIs without writing endpoint code manually.

Features

Core Functionality

• Automatic REST API Generation: Connects to any FireDAC-supported database and automatically creates REST endpoints for tables and views
• CRUD Operations: Full support for Create, Read, Update, and Delete operations
• Fine-Grained Permissions: Configure visibility and access permissions (Select, Insert, Update, Delete) per table
• Multiple Database Support: Works with any database supported by FireDAC (SQL Server, MySQL, PostgreSQL, Oracle, SQLite, etc.)

Integrated Swagger Documentation

• OpenAPI 3.0 Specification: Automatically generates Swagger/OpenAPI documentation for all exposed endpoints
• Interactive UI: Built-in Swagger UI for testing and exploring the API
• Dynamic Updates: Documentation updates automatically when table permissions change

Configuration Management

• Persistent Configuration: Stores database connections and table permissions in SQLite
• Multiple Configurations: Save and switch between different database configurations
• Auto-Connect: Optional automatic connection on startup
• Login Prompt: Configurable database authentication

Architecture

Darest is built with a modular architecture:

?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????
???                    Darest Application                   ???
?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????
???  UI Layer (VCL)                                         ???
???  ?????? Main UI (Configuration & Control)                   ???
???  ?????? Config UI (Database Setup & Permissions)            ???
?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????
???  Business Logic Layer                                   ???
???  ?????? TDataBaseConnector (Core Logic)                     ???
???  ?????? Configuration Management                            ???
???  ?????? Schema Discovery                                    ???
?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????
???  REST API Layer (Horse Framework)                       ???
???  ?????? Dynamic Endpoints (/data/:table)                    ???
???  ?????? Swagger Documentation (/swagger)                    ???
???  ?????? Schema Information (/schema)                        ???
???  ?????? Static File Middleware                              ???
?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????
???  Data Access Layer (FireDAC)                            ???
???  ?????? Database Connection & Query Execution               ???
?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????

Key Components

Installation

Prerequisites

• Delphi (tested with recent versions supporting FireDAC)
• Required libraries:
  • Horse: RESTful web framework for Delphi
  • Horse.Jhonson: JSON middleware for Horse
  • Horse.CORS: CORS support (optional)
  • Horse.JWT: JWT authentication (optional)
  • FireDAC: Database connectivity (included with Delphi)

[!WARNING] FireDAC Driver Availability: The available database drivers depend on your Delphi edition:

• Community Edition: Limited driver support (excludes commercial databases like MS SQL Server, Oracle, DB2)
• Professional/Enterprise/Architect: Full driver support for all databases

Verify that your Delphi edition includes the driver for your target database before attempting to connect. Darest will only work with databases supported by your installed FireDAC drivers.

Building from Source

1. Clone the repository:
   bashCopy

   git clone <repository-url>

2. Open Darest.dproj in Delphi IDE
3. Install required dependencies via Boss (Delphi Package Manager):
   bashCopy

   boss install horse
   boss install horse-jhonson

4. Build the project (Shift+F9)
5. Run the application (F9)

Swagger UI Setup

[!IMPORTANT] Darest includes a bundled Swagger UI for API documentation. The swagger/ folder must be present in the same directory as the Darest executable.

For Development:

• The swagger/ folder is included in the repository
• When running from the IDE, ensure the folder is in your output directory (e.g., Win32/Debug/swagger/), however I'd recommend changing the Project setup and declare a destination folder for the binary.

For Deployment:

• Copy the entire swagger/ folder to the same directory as Darest.exe
• The folder structure should be:
  pascalCopy

  YourDeploymentFolder/
  ????????? Darest.exe
  ????????? swagger/
  ???   ????????? index.html
  ???   ????????? swagger-ui.css
  ???   ????????? swagger-ui-bundle.js
  ???   ????????? swagger-initializer.js
  ???   ????????? ... (other Swagger UI files)
  ????????? Darest.db (created automatically)

Alternative: Download Latest Swagger UI

If you prefer to use the latest version of Swagger UI:

1. Download from: https://github.com/swagger-api/swagger-ui/releases/latest
2. Extract the dist/ folder contents to your swagger/ folder
3. Ensure swagger-initializer.js is configured (Darest updates this automatically)

Usage

First-Time Setup

1. Launch Darest: Run the compiled executable
2. Configure Database Connection:
   • Click the configuration button to open the database setup dialog
   • Select your database driver (MSSQL, MySQL, PostgreSQL, etc.)
   • Enter connection parameters:
     • Server/Host
     • Database name
     • Username/Password
     • Port (if required)
   • Test the connection
3. Configure Table Permissions:
   • After connecting, Darest will discover all tables and views
   • For each table, configure:
     • Visible: Show in API documentation
     • Select: Allow GET requests
     • Insert: Allow POST requests
     • Update: Allow PUT requests
     • Delete: Allow DELETE requests
4. Set Service Port:
   • Configure the port for the REST API (default: 9000)
   • Set the service host URL for Swagger documentation
5. Save Configuration: Your settings are automatically persisted to SQLite

Starting the REST Server

1. Click Start Server in the main UI
2. The REST API will be available at http://localhost:<port>
3. Access Swagger UI at http://localhost:<port>/ or http://localhost:<port>/swagger

API Endpoints

Once the server is running, the following endpoints are automatically available:

Core Endpoints

Data Endpoints (per table)

For each table with permissions enabled:

Example Requests

List all customers (with pagination):

GET http://localhost:9000/data/customers?limit=10&offset=0

Get specific customer:

GET http://localhost:9000/data/customers/123

Create new customer:

POST http://localhost:9000/data/customers
Content-Type: application/json

{
  "name": "John Doe",
  "email": "john@example.com",
  "phone": "555-1234"
}

Update customer:

PUT http://localhost:9000/data/customers/123
Content-Type: application/json

{
  "email": "newemail@example.com",
  "phone": "555-5678"
}

Delete customer:

DELETE http://localhost:9000/data/customers/123

Schema Endpoint

The /schema endpoint returns detailed information about your database structure:

{
  "tables": [
    {
      "name": "customers",
      "columns": [
        {
          "name": "id",
          "type": "INTEGER",
          "nullable": false,
          "primaryKey": true
        },
        {
          "name": "name",
          "type": "VARCHAR(100)",
          "nullable": false
        }
      ]
    }
  ]
}

Project Structure

Darest/
????????? Darest.exe              # Main executable
????????? Darest.db               # SQLite configuration database (auto-created)
????????? swagger/                # Swagger UI files (REQUIRED)
???   ????????? index.html
???   ????????? swagger-ui.css
???   ????????? swagger-ui-bundle.js
???   ????????? swagger-initializer.js  # Auto-updated with host/port
???   ????????? ... (other UI assets)
????????? [FireDAC drivers]       # Database-specific DLLs if needed

A version with a web interface is a great idea too. Horse has already everything, so we could compile it for Linux too (with the correct Delphi version, of course).

Configuration Files

Darest stores configuration in the following locations:

Security Considerations

[!WARNING] Darest is designed for rapid API development and internal use. For production deployments, consider implementing:

• Authentication: Add JWT or API key authentication using Horse.JWT
• Authorization: Implement role-based access control
• CORS Configuration: Restrict allowed origins in production
• HTTPS: Use a reverse proxy (nginx, IIS) with SSL/TLS
• Input Validation: Add validation middleware for request payloads
• Rate Limiting: Prevent abuse with request throttling
• SQL Injection Protection: FireDAC parameterized queries provide basic protection, but validate input

Advanced Configuration

Custom Port Configuration

The default port is defined in Darest.Types.pas:

const
  SERVICE_PORT = 9000;

You can change this in the UI or modify the constant before compilation.

Adding Custom Middleware

To add custom Horse middleware, edit Darest.Logic.pas in the StartRESTServer method:

// Example: Add CORS
THorse.Use(CORS);

// Example: Add custom logging
THorse.Use(procedure(Req: THorseRequest; Res: THorseResponse; Next: TProc)
begin
  WriteLn('Request: ' + Req.RawWebRequest.PathInfo);
  Next;
end);

Database Driver Configuration

Darest supports all FireDAC drivers available in your Delphi installation. Database connectivity depends on:

1. Your Delphi Edition: Community Edition has limited driver support
2. Installed Driver Units: The appropriate FireDAC driver units must be included in the project
3. Runtime Libraries: Some databases require client libraries (DLLs) to be present

Supported Databases (by Delphi Edition)

Community Edition (Free):

• ✅ SQLite (FireDAC.Phys.SQLite)
• ✅ MySQL/MariaDB (FireDAC.Phys.MySQL)
• ✅ PostgreSQL (FireDAC.Phys.PG)
• ✅ InterBase/Firebird (FireDAC.Phys.IB, FireDAC.Phys.FB)
• ❌ MS SQL Server (requires Professional or higher)
• ❌ Oracle (requires Professional or higher)
• ❌ DB2, Informix (require Professional or higher)

Professional/Enterprise/Architect Editions:

• ✅ All Community Edition databases
• ✅ Microsoft SQL Server (FireDAC.Phys.MSSQL)
• ✅ Oracle Database (FireDAC.Phys.Oracle)
• ✅ DB2, Informix, and other enterprise databases

Adding Custom Database Support

To add support for additional databases:

1. Verify the driver is available in your Delphi edition
2. Include the appropriate FireDAC driver units in your project
3. Add required client libraries (DLLs) to your deployment folder if needed
4. Configure connection parameters in the Darest UI
5. The driver is automatically detected from the connection string

[!TIP] For databases requiring client libraries (e.g., Oracle, MS SQL Server with native driver), ensure the appropriate DLLs are in your application directory or system PATH.

Troubleshooting

Server Won't Start

• Check Port Availability: Ensure the configured port is not in use
• Firewall: Allow the application through Windows Firewall
• Database Connection: Verify database is accessible and credentials are correct

Tables Not Appearing

• Permissions: Check database user has SELECT permission on system tables
• Schema: Ensure you're connected to the correct database/schema
• Refresh: Use the reload schema function after database changes

Swagger UI Not Loading

• Static Files: Verify the swagger/ folder exists in the application directory
• Path Configuration: Check STATIC_HTML_FOLDER constant in Darest.Types.pas
• Browser Cache: Clear browser cache and reload

Contributing

Contributions are welcome! Please follow these guidelines:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Follow Delphi coding conventions
4. Add comments in English
5. Test your changes thoroughly
6. Commit your changes (git commit -m 'Add amazing feature')
7. Push to the branch (git push origin feature/amazing-feature)
8. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

MIT License Summary

• ✅ Commercial use
• ✅ Modification
• ✅ Distribution
• ✅ Private use
• ⚠️ Liability and warranty limitations apply

Credits

Developed by: Magno Lima

Built with:

• Horse - RESTful framework for Delphi
• Swagger UI - API documentation interface

Support

For issues, questions, or feature requests, please open an issue on GitHub.

Darest - Turning databases into REST APIs, automatically.