PHPackages apileon/framework - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. apileon/framework ActiveLibrary[Framework](/categories/framework) apileon/framework ================= A lightweight, enterprise-ready PHP framework focused only on REST APIs 00[1 PRs](https://github.com/bandeto45/apileon/pulls)PHPCI passing Since Aug 19Pushed 8mo agoCompare [ Source](https://github.com/bandeto45/apileon)[ Packagist](https://packagist.org/packages/apileon/framework)[ RSS](/packages/apileon-framework/feed)WikiDiscussions main Synced 1mo ago READMEChangelogDependenciesVersions (3)Used By (0) Apileon ๐Ÿฆ ========= [](#apileon-) *A lightweight, enterprise-ready PHP framework focused only on REST APIs.* [![License](https://camo.githubusercontent.com/7013272bd27ece47364536a221edb554cd69683b68a46fc0ee96881174c4214c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e737667)](https://camo.githubusercontent.com/7013272bd27ece47364536a221edb554cd69683b68a46fc0ee96881174c4214c/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d626c75652e737667)[![PHP Version](https://camo.githubusercontent.com/88b464e5614cf654f181925115d47b523dc429fcfe41d59565e42e757f306f29/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d253345253344382e312d3838393242462e737667)](https://camo.githubusercontent.com/88b464e5614cf654f181925115d47b523dc429fcfe41d59565e42e757f306f29/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d253345253344382e312d3838393242462e737667)[![Build Status](https://camo.githubusercontent.com/c27a457659b89ee4f1f80f7995c559dd37f2051bde7167ad25791e5c5c92cc8e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6275696c642d70617373696e672d627269676874677265656e2e737667)](https://camo.githubusercontent.com/c27a457659b89ee4f1f80f7995c559dd37f2051bde7167ad25791e5c5c92cc8e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6275696c642d70617373696e672d627269676874677265656e2e737667)[![PRs Welcome](https://camo.githubusercontent.com/04a4daccbffa4d19acb5431562650baa8cfc58aba75c7d757494d9b4b631f0a9/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5052732d77656c636f6d652d677265656e2e737667)](https://camo.githubusercontent.com/04a4daccbffa4d19acb5431562650baa8cfc58aba75c7d757494d9b4b631f0a9/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5052732d77656c636f6d652d677265656e2e737667) --- ๐Ÿš€ Overview ---------- [](#-overview) **Apileon** is a PHP framework built exclusively for **REST API development**. It is designed with **simplicity, speed, and scalability** in mind โ€” removing unnecessary overhead and focusing on what matters most: **clean and powerful APIs**. Think of Apileon as the **enterprise-grade foundation** for your next API project. --- โœจ Features ---------- [](#-features) - โšก **REST-first architecture** โ€“ built only for APIs, no bloat - ๐Ÿ›  **Simple Routing** โ€“ clean and fast endpoint definitions - ๐Ÿ” **Middleware Support** โ€“ authentication, CORS, rate limiting - ๏ฟฝ๏ธ **Secured Database CRUD** โ€“ enterprise-grade database operations with validation - ๏ฟฝ๐Ÿ“ฆ **Extensible Core** โ€“ modular design for enterprise projects - ๐Ÿ“Š **JSON-first Communication** โ€“ optimized for modern web & mobile apps - ๐Ÿงช **Test-Friendly** โ€“ structured for PHPUnit & CI/CD pipelines - ๐Ÿš€ **Zero Dependencies** โ€“ works with just PHP 8.1+, no Composer required - ๐Ÿ”ง **Auto-loading** โ€“ PSR-4 compliant autoloader included - ๐ŸŒ **Production Ready** โ€“ enterprise-grade security and performance - ๐Ÿ“ˆ **Built-in Performance Monitoring** โ€“ track response times, memory usage, queries โญ - ๐Ÿ’พ **Flexible Caching System** โ€“ file, array, and Redis support โญ - ๐ŸŽฏ **Event System** โ€“ decoupled architecture with custom events โญ - ๐Ÿ” **Health Monitoring** โ€“ built-in health checks and metrics endpoints โญ --- ๐Ÿ“ฆ Installation -------------- [](#-installation) ### Option 1: With Composer (Recommended) [](#option-1-with-composer-recommended) ``` composer create-project apileon/framework my-api ``` ### Option 2: Without Composer (Simple Setup) [](#option-2-without-composer-simple-setup) ``` git clone https://github.com/bandeto45/apileon.git my-api cd my-api ./setup-no-composer.sh ``` **No dependencies required!** - Apileon works with just PHP 8.1+ --- ๐Ÿ›  Quick Start ------------- [](#-quick-start) ### With Composer [](#with-composer) ``` composer create-project apileon/framework my-api cd my-api composer serve ``` ### Without Composer (Just PHP!) [](#without-composer-just-php) ``` git clone https://github.com/bandeto45/apileon.git my-api cd my-api ./setup-no-composer.sh php -S localhost:8000 -t public ``` **2. Define your first route** Edit `routes/api.php`: ``` use Apileon\Routing\Route; Route::get('/hello', function () { return ['message' => 'Hello from Apileon!']; }); ``` **3. Start the server** ``` # With Composer composer serve # Without Composer php -S localhost:8000 -t public ``` **4. Test your endpoint** ``` curl http://localhost:8000/hello ``` Response: ``` { "message": "Hello from Apileon!" } ``` --- ๐Ÿ“‚ Project Structure ------------------- [](#-project-structure) ``` my-api/ โ”œโ”€โ”€ autoload.php # Manual autoloader (no Composer needed) โ”œโ”€โ”€ app/ # Application logic โ”‚ โ”œโ”€โ”€ Controllers/ # HTTP controllers โ”‚ โ”œโ”€โ”€ Models/ # Data models โ”‚ โ””โ”€โ”€ Middleware/ # Custom middleware โ”œโ”€โ”€ config/ # Configuration files โ”‚ โ”œโ”€โ”€ app.php # App configuration โ”‚ โ””โ”€โ”€ database.php # Database configuration โ”œโ”€โ”€ docs/ # Core documentation โ”‚ โ”œโ”€โ”€ README.md # Complete framework guide โ”‚ โ”œโ”€โ”€ API.md # API documentation โ”‚ โ”œโ”€โ”€ routing.md # Routing guide โ”‚ โ”œโ”€โ”€ middleware.md # Middleware guide โ”‚ โ”œโ”€โ”€ testing.md # Testing guide โ”‚ โ””โ”€โ”€ no-composer-setup.md # No-Composer setup โ”œโ”€โ”€ docker/ # Docker configuration โ”‚ โ”œโ”€โ”€ nginx.conf # Nginx configuration โ”‚ โ”œโ”€โ”€ supervisord.conf # Supervisor configuration โ”‚ โ””โ”€โ”€ start.sh # Docker startup script โ”œโ”€โ”€ public/ # Public web root โ”‚ โ”œโ”€โ”€ index.php # Smart entry point (Composer + manual) โ”‚ โ””โ”€โ”€ index-no-composer.php # Explicit no-Composer entry โ”œโ”€โ”€ routes/ # Route definitions โ”‚ โ””โ”€โ”€ api.php # API routes โ”œโ”€โ”€ src/ # Framework core โ”‚ โ”œโ”€โ”€ Foundation/ # Application foundation โ”‚ โ”œโ”€โ”€ Http/ # HTTP components & middleware โ”‚ โ”œโ”€โ”€ Routing/ # Routing system โ”‚ โ””โ”€โ”€ Support/ # Helper utilities & functions โ”œโ”€โ”€ tests/ # PHPUnit tests โ”œโ”€โ”€ vendor/ # Composer dependencies (optional) โ”œโ”€โ”€ .env.example # Environment template โ”œโ”€โ”€ composer.json # Dependencies & autoloading (optional) โ”œโ”€โ”€ phpunit.xml # Testing configuration โ”œโ”€โ”€ setup.sh # Composer setup script โ”œโ”€โ”€ setup-no-composer.sh # No-Composer setup script โ”œโ”€โ”€ status.sh # Status check script โ”œโ”€โ”€ test-no-composer.php # Framework test (no dependencies) โ”‚ โ”œโ”€โ”€ # ๐Ÿš€ Portable Deployment Files โ”œโ”€โ”€ deploy-portable.php # Interactive deployment generator โ”œโ”€โ”€ create-portable.php # Portable ZIP package generator โ”œโ”€โ”€ create-standalone.php # Self-contained executable generator โ”œโ”€โ”€ create-database.php # SQLite database initializer โ”œโ”€โ”€ install-zero-deps.sh # Zero-dependency installer โ”œโ”€โ”€ install-php-and-run.sh # PHP auto-installer โ”œโ”€โ”€ run-docker.sh # Docker launcher (Unix/Linux/macOS) โ”œโ”€โ”€ run-docker.bat # Docker launcher (Windows) โ”œโ”€โ”€ Dockerfile.portable # Docker configuration for portable deployment โ”œโ”€โ”€ docker-compose.portable.yml # Docker Compose for portable deployment โ”‚ โ”œโ”€โ”€ # ๐Ÿ“š Documentation Files โ”œโ”€โ”€ README.md # Main framework documentation โ”œโ”€โ”€ DOCUMENTATION_INDEX.md # Complete documentation index โ”œโ”€โ”€ PORTABLE_DEPLOYMENT_GUIDE.md # Portable deployment guide โ”œโ”€โ”€ DEPENDENCY_REQUIREMENTS.md # With/without PHP deployment guide โ”œโ”€โ”€ DEPLOYMENT_GUIDE.md # Production deployment guide โ”œโ”€โ”€ SECURE_DEPLOYMENT_GUIDE.md # Security deployment guide โ”œโ”€โ”€ DATABASE_CRUD_GUIDE.md # Database operations guide โ””โ”€โ”€ QUICK_DEPLOYMENT_CHEAT_SHEET.md # Quick reference for deployment ``` --- โš™๏ธ Configuration ---------------- [](#๏ธ-configuration) - `.env` file for environment variables - `config/` for database, caching, and app settings Example `.env`: ``` APP_ENV=local APP_KEY=base64:randomkeyhere APP_DEBUG=true DB_CONNECTION=mysql DB_HOST=127.0.0.1 DB_PORT=3306 DB_DATABASE=apileon DB_USERNAME=root DB_PASSWORD= ``` --- ๐Ÿ—„๏ธ Database & CRUD Operations --------------------------------- [](#๏ธ-database--crud-operations) Apileon includes a comprehensive, secured database CRUD system with enterprise-grade features: ### Quick Database Setup [](#quick-database-setup) ``` # Configure database in .env file cp .env.example .env # Run migrations to create tables php artisan migrate # Seed database with sample data php artisan db:seed ``` ### Model Example [](#model-example) ``` use App\Models\User; // Create a new user (password auto-hashed) $user = User::create([ 'name' => 'John Doe', 'email' => 'john@example.com', 'password' => 'secure_password' ]); // Find users $user = User::find(1); $users = User::where('status', 'active')->get(); $paginated = User::paginate(10, 1); // Update user $user->update(['name' => 'John Smith']); // Delete user $user->delete(); ``` ### Security Features [](#security-features) - โœ… **SQL Injection Protection** - All queries use prepared statements - โœ… **Mass Assignment Protection** - Fillable/guarded attributes - โœ… **Password Security** - Automatic bcrypt hashing - โœ… **Input Validation** - 20+ validation rules - โœ… **Error Handling** - Comprehensive error responses ### Available CLI Commands [](#available-cli-commands) ``` # Development Commands php artisan migrate # Run database migrations php artisan migrate:rollback # Rollback migrations php artisan db:seed # Seed database with data php artisan make:model Post # Generate new model php artisan make:controller PostController # Generate controller php artisan serve # Start development server # Security & Deployment Commands php artisan security:check # Run comprehensive security validation php artisan package:secure # Create secure deployment package # Portable Deployment Commands php deploy-portable.php # Interactive portable deployment generator php create-portable.php # Create portable ZIP package php create-standalone.php # Create self-contained executable ./install-zero-deps.sh # Zero-dependency deployment ./install-php-and-run.sh # Auto-install PHP and run ``` **๐Ÿ“– Complete Guide:** See [DATABASE\_CRUD\_GUIDE.md](DATABASE_CRUD_GUIDE.md) for full documentation. --- ๐Ÿงฉ Middleware Example -------------------- [](#-middleware-example) ``` use Apileon\Http\Middleware; class AuthMiddleware extends Middleware { public function handle($request, $next) { if (!$request->header('Authorization')) { return response()->json(['error' => 'Unauthorized'], 401); } return $next($request); } } ``` Attach middleware to routes: ``` Route::get('/profile', 'UserController@profile')->middleware('auth'); ``` --- ๐Ÿงช Testing --------- [](#-testing) ### With Composer (Full Testing) [](#with-composer-full-testing) ``` # Run all tests composer test # Run specific test vendor/bin/phpunit tests/RequestTest.php # Generate coverage report vendor/bin/phpunit --coverage-html coverage/ ``` ### Without Composer (Basic Testing) [](#without-composer-basic-testing) ``` # Test framework functionality php test-no-composer.php # Manual syntax check find . -name "*.php" -exec php -l {} \; ``` --- ๐Ÿ“– Documentation --------------- [](#-documentation) Full documentation available in the `docs/` folder and root directory: ### ๐Ÿ“š **Core Framework Documentation** [](#-core-framework-documentation) - **[Complete Guide](docs/README.md)** - Framework documentation - **[No Composer Setup](docs/no-composer-setup.md)** - Use without Composer - **[API Reference](docs/API.md)** - Endpoint documentation - **[Routing Guide](docs/routing.md)** - Advanced routing patterns - **[Middleware Guide](docs/middleware.md)** - Security & custom middleware - **[Testing Guide](docs/testing.md)** - Unit & integration testing ### ๐Ÿš€ **Deployment & Production Documentation** [](#-deployment--production-documentation) - **[Portable Deployment Guide](PORTABLE_DEPLOYMENT_GUIDE.md)** - Complete portable deployment options - **[Dependency Requirements](DEPENDENCY_REQUIREMENTS.md)** - With/without PHP deployment guide - **[Deployment Guide](DEPLOYMENT_GUIDE.md)** - Production deployment and security - **[Secure Deployment Guide](SECURE_DEPLOYMENT_GUIDE.md)** - Advanced security deployment - **[Database CRUD Guide](DATABASE_CRUD_GUIDE.md)** - Database operations and security ### ๐Ÿ›  **Quick Reference** [](#-quick-reference) - **[.env.example](.env.example)** - Environment configuration template - **[composer.json](composer.json)** - Dependencies and autoloading - **[phpunit.xml](phpunit.xml)** - Testing configuration --- ๐Ÿš€ Quick Examples ---------------- [](#-quick-examples) ### Create a Simple API [](#create-a-simple-api) ``` // routes/api.php use Apileon\Routing\Route; Route::get('/users', function() { return [ 'users' => [ ['id' => 1, 'name' => 'John Doe', 'email' => 'john@example.com'], ['id' => 2, 'name' => 'Jane Smith', 'email' => 'jane@example.com'] ], 'total' => 2 ]; }); Route::get('/users/{id}', function($request) { $id = $request->param('id'); return [ 'user' => [ 'id' => $id, 'name' => 'User ' . $id, 'email' => "user{$id}@example.com" ] ]; }); Route::post('/users', function($request) { $data = $request->all(); return [ 'message' => 'User created successfully', 'user' => [ 'id' => rand(100, 999), 'name' => $data['name'] ?? 'Unknown', 'email' => $data['email'] ?? 'unknown@example.com' ] ]; }); ``` ### Add Authentication [](#add-authentication) ``` // Protected routes Route::group(['middleware' => ['auth']], function() { Route::get('/profile', function($request) { return ['user' => ['id' => 1, 'name' => 'Authenticated User']]; }); Route::put('/profile', function($request) { return ['message' => 'Profile updated', 'data' => $request->all()]; }); }); // Usage: curl -H "Authorization: Bearer your-token" http://localhost:8000/profile ``` ### Custom Controller [](#custom-controller) ``` // app/Controllers/PostController.php