PHPackages                             dcardenasl/ci4-api-scaffolding - 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. [API Development](/categories/api)
4. /
5. dcardenasl/ci4-api-scaffolding

ActiveLibrary[API Development](/categories/api)

dcardenasl/ci4-api-scaffolding
==============================

CRUD scaffolding engine for CodeIgniter 4 APIs built on dcardenasl/ci4-api-core. Generates DTOs, services, controllers, migrations, routes, tests and OpenAPI docs via spark commands.

v0.7.6.2(1w ago)0644↑21.1%MITPHPPHP ^8.2CI passing

Since May 10Pushed 3d agoCompare

[ Source](https://github.com/dcardenasl/ci4-api-scaffolding)[ Packagist](https://packagist.org/packages/dcardenasl/ci4-api-scaffolding)[ Docs](https://github.com/dcardenasl/ci4-api-scaffolding)[ RSS](/packages/dcardenasl-ci4-api-scaffolding/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (10)Dependencies (32)Versions (20)Used By (0)

ci4-api-scaffolding
===================

[](#ci4-api-scaffolding)

[![CI](https://github.com/dcardenasl/ci4-api-scaffolding/actions/workflows/ci.yml/badge.svg)](https://github.com/dcardenasl/ci4-api-scaffolding/actions/workflows/ci.yml)[![License: MIT](https://camo.githubusercontent.com/08cef40a9105b6526ca22088bc514fbfdbc9aac1ddbf8d4e6c750e3a88a44dca/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d626c75652e737667)](LICENSE)[![PHP](https://camo.githubusercontent.com/187240af044d09d5b14a1d9d9ebdf3f7a993e4c7bc09bdb46b4ba661a891bf5b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048502d382e322532422d626c7565)](https://www.php.net/)[![CI4](https://camo.githubusercontent.com/dc23ae09d55391c73f24176ef89e1c8e119348992dd7f4408b7784a09b3e4db7/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f436f646549676e697465722d342e372532422d6f72616e6765)](https://codeigniter.com/)[![Latest Stable Version](https://camo.githubusercontent.com/afd21d603c2263bf3b4c7d3ccc41622c2078d681f5725e88092b910168943b2b/68747470733a2f2f706f7365722e707567782e6f72672f6463617264656e61736c2f6369342d6170692d73636166666f6c64696e672f76)](https://packagist.org/packages/dcardenasl/ci4-api-scaffolding)[![Total Downloads](https://camo.githubusercontent.com/d281b52dbf3814fc7794517213ea420fae50fec2689177303c1076016012267c/68747470733a2f2f706f7365722e707567782e6f72672f6463617264656e61736c2f6369342d6170692d73636166666f6c64696e672f646f776e6c6f616473)](https://packagist.org/packages/dcardenasl/ci4-api-scaffolding)

CRUD scaffolding engine for CodeIgniter 4 APIs built on [`dcardenasl/ci4-api-core`](https://github.com/dcardenasl/ci4-api-core). One command generates DTOs, service, controller, migration, routes, language files, and tests — all wired to the `ci4-api-core` base classes.

> **Pre-1.0 policy:** MINOR bumps may contain breaking changes. Pin to `~0.x.0` or exact version until v1.0.0.

Table of Contents
-----------------

[](#table-of-contents)

- [Requirements](#requirements)
- [Installation](#installation)
- [Quick Start](#quick-start)
- [Configuration](#configuration)
- [Available Commands](#available-commands)
- [Field Types](#field-types)
- [Field Modifiers](#field-modifiers)
- [Generated Artifacts](#generated-artifacts)
- [Scaffolding Boundaries](#scaffolding-boundaries)
- [Compatibility Matrix](#compatibility-matrix)
- [Development](#development)
- [Troubleshooting](#troubleshooting)
- [Example Project](#example-project)

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

[](#requirements)

- PHP `^8.2`
- CodeIgniter 4 `^4.7`
- [`dcardenasl/ci4-api-core`](https://packagist.org/packages/dcardenasl/ci4-api-core) `^0.9` (installed automatically as a dependency)

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

[](#installation)

```
composer require --dev dcardenasl/ci4-api-scaffolding:^0.7
```

Quick Start
-----------

[](#quick-start)

```
bash vendor/bin/make-crud.sh Article Blog \
  'title:string:required|searchable,body:text:required,published:bool:nullable' yes

php spark module:check Article --domain Blog
php spark migrate
```

Configuration
-------------

[](#configuration)

Create `app/Config/Scaffolding.php` extending `BaseScaffoldingConfig`. If your project follows `ci4-api-starter` conventions, the bundled defaults work without any overrides:

```