PHPackages                             quikapi/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. quikapi/framework

ActiveProject[Framework](/categories/framework)

quikapi/framework
=================

QuikAPI - a lightweight, fast PHP microframework for building APIs quickly.

v0.1.2(7mo ago)01MITPHPPHP >=8.1CI failing

Since Sep 29Pushed 7mo agoCompare

[ Source](https://github.com/QuikAPI/framework)[ Packagist](https://packagist.org/packages/quikapi/framework)[ Docs](https://github.com/QuikAPI/framework)[ RSS](/packages/quikapi-framework/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (9)Versions (5)Used By (0)

QuikAPI
=======

[](#quikapi)

A lightweight, fast PHP microframework for building APIs quickly.

[![Packagist Version](https://camo.githubusercontent.com/4acd09da7466d294810dc2b1f941bcb285d5dd8e571f7a43a18d9aa94d431ab4/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7175696b6170692f6672616d65776f726b)](https://packagist.org/packages/quikapi/framework)[![PHP from Packagist](https://camo.githubusercontent.com/8c754e698cb3c2d76929cc923537cd6d5790f27ca97e9f2ad77fe3548174c9e2/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f7175696b6170692f6672616d65776f726b)](https://camo.githubusercontent.com/8c754e698cb3c2d76929cc923537cd6d5790f27ca97e9f2ad77fe3548174c9e2/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f7175696b6170692f6672616d65776f726b)[![Downloads](https://camo.githubusercontent.com/6036adae7e009ea3f62e0f29b91021c00ab3d7c1e3f08b145bd057bcf0912b61/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f7175696b6170692f6672616d65776f726b)](https://packagist.org/packages/quikapi/framework)[![License](https://camo.githubusercontent.com/9b09d58ae928c336aacec7cc2ef8370a9f0c736e9c828ec2864abecde1120fb2/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f5175696b4150492f6672616d65776f726b)](LICENSE)[![CI](https://github.com/QuikAPI/framework/actions/workflows/ci.yml/badge.svg?branch=master)](.github/workflows/ci.yml)

- **Simple**: Minimal concepts. Define routes and controllers that return arrays.
- **Fast**: Tiny core with zeroheavy dependencies at runtime.
- **Modern**: PSR-4, middleware, JSON-first, PDO-ready, `.env` support.
- **Productive**: Built-in CLI to scaffold controllers/models/modules.

Requirements
------------

[](#requirements)

- PHP >= 8.1
- ext-PDO (e.g., pdo\_mysql)

Installation
------------

[](#installation)

Option A — Create a fresh project (recommended):

```
composer create-project quikapi/framework my-api
cd my-api
# .env will be auto-copied by composer scripts; if not:
cp .env.example .env
```

Option B — Use in an existing repo:

```
composer install
cp .env.example .env
```

Then edit `.env` for your DB and CORS settings.

Quickstart (Dev Server)
-----------------------

[](#quickstart-dev-server)

Run QuikAPI on PHP's built-in server:

```
php -S 127.0.0.1:8082 QuikAPI/server.php
```

Visit `http://127.0.0.1:8082/health` →

```
{"status":"ok","time":"..."}
```

Routing
-------

[](#routing)

Add routes in `QuikAPI/routes.php`:

```
use QuikAPI\Controllers\HealthController;

$router->get('/health', [HealthController::class, 'index']);
```

Supported verbs: `get`, `post`, `put`, `patch`, `delete`. Path params: `/users/{id}` → available in `$req->params['id']`.

Controllers
-----------

[](#controllers)

Controllers are simple classes returning arrays. Example:

```
namespace QuikAPI\Controllers;

use QuikAPI\Http\Request;

class UserController {
    public function index(Request $req): array { return ['items' => []]; }
    public function show(Request $req): array { return ['id' => $req->params['id'] ?? null]; }
}
```

Middleware
----------

[](#middleware)

Global middleware is registered in `QuikAPI/index.php`:

- `QuikAPI\Middleware\ErrorHandler` → JSON error responses
- `QuikAPI\Middleware\Cors` → CORS headers / OPTIONS

You can also pass route-specific middleware in `Router::add()`.

Database (PDO)
--------------

[](#database-pdo)

Configure in `.env`:

```
DB_DSN=mysql:host=127.0.0.1;dbname=app;charset=utf8mb4
DB_USER=root
DB_PASS=

```

Use `QuikAPI\Database\Connection::get()` to obtain a shared PDO instance.

Security
--------

[](#security)

Use `QuikAPI\Security\Password` for password hashing and verification:

```
$hash = Password::hash($plain);
$ok = Password::verify($plain, $hash);
```

CLI
---

[](#cli)

Built-in simple CLI to scaffold modules:

```
php quikapi make:controller User
php quikapi make:model User
php quikapi make:module Post
```

This will append REST routes to `QuikAPI/routes.php` and create the controller/model.

Project Structure
-----------------

[](#project-structure)

```
QuikAPI/
  Controllers/
  Database/
  Http/
  Middleware/
  Security/
  routes.php
  index.php
  server.php
  cli.php

```

Roadmap
-------

[](#roadmap)

- Symfony Console based CLI (route:list, serve, etc.)
- Request/Response interfaces and typed responses
- Validation utilities
- Auth middleware (JWT/session)

Support & Policy
--------------------

[](#support--policy)

- **Branching**: Default branch is `master`. Dev stability via branch-alias `dev-master` → `0.1.x-dev`.
- **Versioning**: Semantic Versioning. Breaking changes only in major releases.
- **Backward compatibility**: No breaking changes in minor releases; deprecations announced one minor before removal.
- **Security**: See `SECURITY.md` and report privately before disclosure.

License
-------

[](#license)

MIT

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance62

Regular maintenance activity

Popularity1

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity37

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

3

Last Release

230d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/36871ba450f91fcbb2cf56d94bfbb5be9f7ea7f0fed2fc178b867ea022ffb2f7?d=identicon)[brnrajoriya](/maintainers/brnrajoriya)

---

Top Contributors

[![brnrajoriya](https://avatars.githubusercontent.com/u/9497444?v=4)](https://github.com/brnrajoriya "brnrajoriya (6 commits)")

---

Tags

phpmiddlewareapiframeworkroutermicroframework

###  Code Quality

TestsPHPUnit

Static AnalysisPsalm

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/quikapi-framework/health.svg)

```
[![Health](https://phpackages.com/badges/quikapi-framework/health.svg)](https://phpackages.com/packages/quikapi-framework)
```

###  Alternatives

[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

245.2k](/packages/aedart-athenaeum)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)