PHPackages celeris/api - 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. celeris/api ActiveProject[Framework](/categories/framework) celeris/api =========== Celeris API base application scaffold for building service-oriented and REST APIs. 1.0.0(1mo ago)05MITPHPPHP >=8.4 Since May 8Pushed 1mo agoCompare [ Source](https://github.com/jgarcias-cr/celeris-api)[ Packagist](https://packagist.org/packages/celeris/api)[ RSS](/packages/celeris-api/feed)WikiDiscussions main Synced 1w ago READMEChangelogDependencies (1)Versions (2)Used By (0) Celeris API Stub ================ [](#celeris-api-stub) `celeris/api` is a base application scaffold for building REST APIs and service-oriented backends on top of `celeris/framework`. It gives you a practical starting point instead of an empty shell: a bootstrapped HTTP entrypoint, API controllers, DTOs, services, repositories, config files, migrations, seeded example data, and optional notification worker hooks. What It Is For -------------- [](#what-it-is-for) Use this package when you want to start a new API quickly without rebuilding the same foundation each time. It is a good fit for: - internal business APIs - service-oriented backends - CRUD-heavy applications - authenticated JSON APIs - projects that may later grow into event-driven or notification-enabled services Included Features ----------------- [](#included-features) - API-first bootstrap with a JSON root endpoint and `/health` style service readiness flow - Example auth endpoints under `/api/auth` for login and identity inspection - Example resource endpoints under `/api/contacts` - Attribute-based routing through Celeris controllers - DTO-driven request input mapping for create and update flows - Service and repository layers already separated for easier maintenance - Autodiscovered model lifecycle listeners for `onCreate`, `onUpdate`, `onDelete`, and `onShow` - Database configuration, migrations, and seed data out of the box - Environment-based security toggles for JWT, opaque tokens, cookie sessions, API tokens, and mTLS - Built-in rate-limit configuration - Optional notification integrations for SMTP, in-app notifications, transactional outbox, realtime delivery, and dispatch workers - CLI wrappers for migrations and worker scripts Advantages ---------- [](#advantages) - Faster project setup: you can begin with working application structure immediately - Clear boundaries: controllers, services, repositories, DTOs, config, and bootstrap are already organized - Safer customization: generated base classes and extension points make it easier to evolve scaffolded code cleanly - Production-friendly direction: auth, rate limiting, migrations, and notification workflows are already anticipated - Monorepo-friendly local development: the stub can run against the local framework package during development Default API Surface ------------------- [](#default-api-surface) The scaffold currently exposes these starter endpoints: - `GET /` returns basic API and framework metadata - `POST /api/auth/login` authenticates the demo user and returns a token payload - `GET /api/auth/me` returns the authenticated identity - `GET /api/contacts` lists contacts - `GET /api/contacts/{id}` fetches one contact - `POST /api/contacts` creates a contact - `PUT /api/contacts/{id}` updates a contact - `DELETE /api/contacts/{id}` deletes a contact Model lifecycle listeners live under `app/Listeners/Models` and are registered automatically by `AppServiceProvider`. Treat these as a starting point. They are intentionally simple so you can replace, extend, or remove them as your real domain takes shape. Quick Start ----------- [](#quick-start) Create a project from the package: ``` composer create-project celeris/api my-api cd my-api cp .env.example .env composer install php celeris app-key php bin/migrate.php up php -S 127.0.0.1:8000 -t public ``` If you are working inside the Celeris monorepo, the scaffold can also fall back to the local framework bootstrap and CLI binary during development. Project Structure ----------------- [](#project-structure) - `public/index.php` boots the HTTP kernel and loads route files - `routes/api.php` registers API controllers and direct API routes - `app/Http/Controllers/v1` contains your versioned API controllers - `app/Http/DTOs` contains request DTOs - `app/Services` holds application use cases - `app/Repositories` contains persistence-facing code - `database/migrations` contains schema changes - `database/seeds` contains sample seed data - `config` centralizes environment-driven app behavior - `bin` contains migration and notification worker helpers Notifications and Background Work --------------------------------- [](#notifications-and-background-work) The stub is ready for optional notification packages, but keeps them disabled by default. That means you can start lean and only enable the pieces you actually need. When those packages are installed, the scaffold already includes entrypoints such as: - `php bin/notifications-dispatch-worker.php` - `php bin/notifications-replay-dead-letter.php` This makes the package a nice fit for APIs that may grow from simple synchronous CRUD into more resilient event-driven workflows. Recommendations --------------- [](#recommendations) - Replace the sample `Contact` domain early with your real bounded context - Copy `.env.example` to `.env` and explicitly review all security flags before deploying - Set `APP_KEY` and `JWT_SECRET` before enabling JWT authentication - Keep auth strategies opt-in; only enable the ones your service truly needs - Treat the demo credentials as development-only scaffolding - Add your domain-specific tests as soon as you start replacing the example endpoints - If you adopt the outbox flow, run the dispatch worker separately from the HTTP process Tip --- [](#tip) The best way to use this stub is not to preserve every sample file, but to preserve the structure. Replace the demo domain quickly, keep the layering, and let the scaffold accelerate your first real feature instead of becoming long-lived placeholder code. ### Health Score 41 — FairBetter than 87% of packages Maintenance94 Actively maintained with recent releases Popularity4 Limited adoption so far Community8 Small or concentrated contributor base Maturity51 Maturing project, gaining track record Bus Factor1 Top contributor holds 78.8% 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 Unknown Total 1 Last Release 32d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/90e28732274c3c892bed8cb648281ab3cabcae63cd06df439c6c0d703c097250?d=identicon)[jgarcias](/maintainers/jgarcias) --- Top Contributors [![jgarcias-cr](https://avatars.githubusercontent.com/u/202754121?v=4)](https://github.com/jgarcias-cr "jgarcias-cr (26 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (7 commits)") --- Tags apiframeworkSkeletonstarterceleris ### Embed Badge ![Health badge](/badges/celeris-api/health.svg) ``` [![Health](https://phpackages.com/badges/celeris-api/health.svg)](https://phpackages.com/packages/celeris-api) ``` ### Alternatives [psx/psx PHP REST API Framework 17112.6k3](/packages/psx-psx) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)