docs: Created a new Make an RESTful API guide

user_guide_src/source/guides/api/code/001.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace App\Controllers\Api;
+
+use App\Controllers\BaseController;
+use CodeIgniter\API\ResponseTrait;
+
+class Ping extends BaseController
+{
+    use ResponseTrait;
+
+    public function getIndex()
+    {
+        return $this->respond(['status' => 'ok'], 200);
+    }
+}

user_guide_src/source/guides/api/code/002.php

@@ -0,0 +1,18 @@
+<?php
+
+namespace App\Controllers\Api;
+
+use App\Controllers\BaseController;
+use CodeIgniter\API\ResponseTrait;
+
+class Ping extends BaseController
+{
+    use ResponseTrait;
+
+    protected $format = 'json';
+
+    public function getIndex()
+    {
+        return $this->respond(['status' => 'ok'], 200);
+    }
+}

user_guide_src/source/guides/api/code/003.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Controllers\Api;
+
+use App\Controllers\BaseController;
+use CodeIgniter\API\ResponseTrait;
+use CodeIgniter\CodeIgniter;
+
+class Ping extends BaseController
+{
+    use ResponseTrait;
+
+    public function getIndex()
+    {
+        return $this->respond([
+            'status'  => 'ok',
+            'time'    => date('c'),
+            'version' => CodeIgniter::CI_VERSION,
+        ]);
+    }
+}

user_guide_src/source/guides/api/code/004.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace App\Database\Migrations;
+
+use CodeIgniter\Database\Migration;
+
+class CreateAuthorsTable extends Migration
+{
+    public function up()
+    {
+        $this->forge->addField([
+            'id' => [
+                'type'           => 'INTEGER',
+                'unsigned'       => true,
+                'auto_increment' => true,
+            ],
+            'name' => [
+                'type'       => 'VARCHAR',
+                'constraint' => '255',
+                'null'       => false,
+            ],
+            'created_at' => [
+                'type' => 'DATETIME',
+                'null' => true,
+            ],
+            'updated_at' => [
+                'type' => 'DATETIME',
+                'null' => true,
+            ],
+        ]);
+
+        $this->forge->addPrimaryKey('id');
+        $this->forge->addUniqueKey('name');
+        $this->forge->createTable('authors');
+    }
+
+    public function down()
+    {
+        $this->forge->dropTable('authors');
+    }
+}

user_guide_src/source/guides/api/code/005.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace App\Database\Migrations;
+
+use CodeIgniter\Database\Migration;
+
+class CreateBooksTable extends Migration
+{
+    public function up()
+    {
+        $this->forge->addField([
+            'id' => [
+                'type'           => 'INTEGER',
+                'unsigned'       => true,
+                'auto_increment' => true,
+            ],
+            'title' => [
+                'type'       => 'VARCHAR',
+                'constraint' => '255',
+                'null'       => false,
+            ],
+            'author_id' => [
+                'type'     => 'INTEGER',
+                'unsigned' => true,
+                'null'     => false,
+            ],
+            'year' => [
+                'type' => 'INTEGER',
+                'null' => true,
+            ],
+            'created_at' => [
+                'type' => 'DATETIME',
+                'null' => true,
+            ],
+            'updated_at' => [
+                'type' => 'DATETIME',
+                'null' => true,
+            ],
+        ]);
+
+        $this->forge->addPrimaryKey('id');
+        $this->forge->addForeignKey('author_id', 'authors', 'id');
+        $this->forge->createTable('books');
+    }
+
+    public function down()
+    {
+        $this->forge->dropTable('books');
+    }
+}

user_guide_src/source/guides/api/code/006.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace App\Database\Seeds;
+
+use CodeIgniter\Database\Seeder;
+
+class BookSeeder extends Seeder
+{
+    public function run()
+    {
+        // Define author data and insert
+        $authorData = [
+            ['name' => 'Frank Herbert'],
+            ['name' => 'William Gibson'],
+            ['name' => 'Ursula K. Le Guin'],
+        ];
+
+        $this->db->table('authors')->insertBatch($authorData);
+
+        // Get all inserted authors, keyed by name for easy lookup
+        $authors = $this->db->table('authors')
+            ->get()
+            ->getResultArray();
+
+        $authorsByName = array_column($authors, 'id', 'name');
+
+        // Define books with author references
+        $books = [
+            [
+                'title'     => 'Dune',
+                'author_id' => $authorsByName['Frank Herbert'],
+                'year'      => 1965,
+            ],
+            [
+                'title'     => 'Neuromancer',
+                'author_id' => $authorsByName['William Gibson'],
+                'year'      => 1984,
+            ],
+            [
+                'title'     => 'The Left Hand of Darkness',
+                'author_id' => $authorsByName['Ursula K. Le Guin'],
+                'year'      => 1969,
+            ],
+        ];
+
+        $this->db->table('books')->insertBatch($books);
+    }
+}

user_guide_src/source/guides/api/code/007.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace App\Models;
+
+use CodeIgniter\Model;
+
+class AuthorModel extends Model
+{
+    protected $table         = 'authors';
+    protected $primaryKey    = 'id';
+    protected $allowedFields = ['name'];
+    protected $useTimestamps = true;
+}

user_guide_src/source/guides/api/code/008.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace App\Models;
+
+use CodeIgniter\Model;
+
+class BookModel extends Model
+{
+    protected $table         = 'books';
+    protected $primaryKey    = 'id';
+    protected $allowedFields = ['title', 'author_id', 'year'];
+    protected $useTimestamps = true;
+}

user_guide_src/source/guides/api/code/009.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace App\Controllers\Api;
+
+use App\Controllers\BaseController;
+use CodeIgniter\Api\ResponseTrait;
+
+class Books extends BaseController
+{
+    use ResponseTrait;
+
+    protected $format = 'json';
+
+    /**
+     * List one or many resources
+     * GET /api/books
+     *    and
+     * GET /api/books/{id}
+     */
+    public function getIndex(?int $id = null)
+    {
+    }
+
+    /**
+     * Update a book
+     *
+     * PUT /api/books/{id}
+     */
+    public function putIndex(int $id)
+    {
+    }
+
+    /**
+     * Create a new book
+     *
+     * POST /api/books
+     */
+    public function postIndex()
+    {
+    }
+
+    /**
+     * Delete a book
+     *
+     * DELETE /api/books/{id}
+     */
+    public function deleteIndex(int $id)
+    {
+    }
+}

user_guide_src/source/guides/api/code/010.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace App\Transformers;
+
+use CodeIgniter\API\BaseTransformer;
+
+class AuthorTransformer extends BaseTransformer
+{
+    public function toArray(mixed $resource): array
+    {
+        return [
+            'id'   => $resource['id'],
+            'name' => $resource['name'],
+        ];
+    }
+}

user_guide_src/source/guides/api/code/011.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace App\Transformers;
+
+use CodeIgniter\API\BaseTransformer;
+
+class BookTransformer extends BaseTransformer
+{
+    public function toArray(mixed $resource): array
+    {
+        return [
+            'id'    => $resource['id'],
+            'title' => $resource['title'],
+            'year'  => $resource['year'],
+        ];
+    }
+
+    protected function includeAuthor(array $book): ?array
+    {
+        if (empty($book['author_id']) || empty($book['author_name'])) {
+            return null;
+        }
+
+        return [
+            'id'   => $book['author_id'],
+            'name' => $book['author_name'],
+        ];
+    }
+}