Skip to content
NaluzPHPNaluzPHP

Getting Started

This walkthrough adds an articles JSON API to a fresh project. It uses the generators, the ORM, validation and the router, so you meet most of the framework in a few minutes. Make sure you have installed the skeleton first.

1. Generate the pieces

Section titled “1. Generate the pieces”
Terminal window
php naluz make:migration create_articles_table
php naluz make:model Article
php naluz make:controller ArticleController

2. Define the table

Section titled “2. Define the table”

Edit the new file in database/migrations/:

database/migrations/…_create_articles_table.php
return new class extends Migration {
    public function up(Schema $schema): void
    {
        $schema->create('articles', function ($t) {
            $t->id();
            $t->string('title');
            $t->text('body');
            $t->timestamps();
        });
    }


    public function down(Schema $schema): void
    {
        $schema->dropIfExists('articles');
    }
};

3. Describe the model

Section titled “3. Describe the model”

Mass assignment is disabled until you list the fillable fields:

app/Models/Article.php
class Article extends \Naluz\Database\Orm\Model
{
    protected array $fillable = ['title', 'body'];
}

4. Write the controller

Section titled “4. Write the controller”
app/Http/Controllers/ArticleController.php
use App\Models\Article;
use Naluz\Http\Request;
use Naluz\Http\Response;
use Naluz\Validation\Validator;
use Psr\Http\Message\ServerRequestInterface;


final class ArticleController
{
    public function index(): array
    {
        return Article::latest()->get()->toArray();
    }


    public function store(ServerRequestInterface $request): Response
    {
        $data = Validator::make(Request::input($request), [
            'title' => 'required|string|max:200',
            'body'  => 'required|string',
        ])->validate();


        return Response::json(Article::create($data), 201);
    }


    public function show(int $article): Article
    {
        return Article::findOrFail($article);
    }
}

Controllers are plain classes. The container injects dependencies by type, route parameters by name, and the return value is turned into a response. See Controllers.

5. Add the routes

Section titled “5. Add the routes”
routes/api.php
$router->apiResource('articles', ArticleController::class);

Routes in routes/api.php are served under /api, are stateless and are rate limited. See Routing.

6. Run it

Section titled “6. Run it”
Terminal window
php naluz migrate
php naluz route:list
php naluz run:server --port=8001
Terminal window
curl -s localhost:8001/api/articles \
  -H 'Content-Type: application/json' \
  -d '{"title":"Hello","body":"First post"}'


curl -s localhost:8001/api/articles

An invalid request returns 422 with the messages per field:

{ "message": "The given data was invalid.", "errors": { "title": ["The title field is required."] } }

Where to go from here

Section titled “Where to go from here”