docs: Created a new Make an RESTful API guide #9808

lonnieezell · 2025-11-21T16:14:46Z

Description
This creates a new "Getting Started with RESTful APIs" guide that steps through using the auto-routing and ResponseTrait, plus the new transformers and API response pagination to create a simple API.

It moves the existing tutorial under a new "Guides" section.

neznaika0

Guides are a great idea. We can discuss on the forum what built-in mechanics are possible using the framework. I tried to tell you about the Validator, but you didn't approve.

I looked it up from phone.

neznaika0 · 2025-11-21T18:12:41Z

user_guide_src/source/guides/api/controller.rst

+
+.. code-block:: console
+
+    php spark make:controller Api/Books


Book or Books? You use a different naming convention below the text.
It is recommended to name endpoints in the plural /books/123

neznaika0 · 2025-11-21T18:19:58Z

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

+
+class BookModel extends Model
+{
+    protected string $table        = 'books';


Many people recommend naming tables in the singular: book, author

I can't check everything, but could it affect the internal automation? Is there a dependence on the ending "s"?

neznaika0 · 2025-11-21T18:26:05Z

user_guide_src/source/guides/api/database-setup.rst

+
+This creates a new file under ``app/Database/Migrations/``.
+
+Edit the CreateAuthorsTable file to look like this:


The file here is ``CreateAuthorsTable.php`` For visual perception.

neznaika0 · 2025-11-21T18:26:23Z

user_guide_src/source/guides/api/database-setup.rst

+
+Each author simply has a name for our purposes. We have made the name a uncommented unique key to prevent duplicates.
+
+Now edit the CreateBooksTable file to look like this:


The file here is ``CreateBooksTable.php`` For visual perception.

neznaika0 · 2025-11-21T18:30:15Z

user_guide_src/source/guides/api/first-endpoint.rst

+
+The "Improved" auto router is more secure and reliable than the legacy version, so it's recommended for all new projects.
+
+Then, in ``app/Config/Routing.php`` confirm auto routing is **on**:


On? Maybe "enabled"?

neznaika0 · 2025-11-22T03:38:55Z

user_guide_src/source/guides/api/index.rst

+Getting Started with REST APIs
+##############################
+
+.. content::


Typo .. contents::

neznaika0 · 2025-11-22T03:43:05Z

You have moved the pages to the directory. Some error correction paths need to be updated.
../outgoing/* >> ../../outgoing/*

michalsn

This looks great - it's a really nice introduction to the topic and a solid guide overall.

As mentioned, there are a few issues with the links (since we reference the tutorial in several places), and some of the images appear to be broken.

The only thing I'm not happy with is the current navigation. Subpages aren't visible in the left menu when you enter a specific guide category, which makes it difficult to move between different parts of the guide. Setting 'navigation_depth': 3 in conf.py should fix this.

Other than that, everything looks very good.

datamweb · 2025-12-08T07:54:38Z

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

+    public function putIndex(int $id)
+    {
+        $data  = $this->request->getRawInput();
+        $model = model('BookModel');


Suggested change

$model = model('BookModel');

datamweb · 2025-12-08T07:56:38Z

user_guide_src/source/guides/api/controller.rst

+
+    php spark make:controller Api/Books
+
+This creates ``app/Controllers/Api/Books.php``.


Suggested change

This creates ``app/Controllers/Api/Books.php``.

This creates **app/Controllers/Api/Books.php**.

datamweb · 2025-12-08T07:57:42Z

user_guide_src/source/guides/api/controller.rst

+
+.. tip::
+
+   If you prefer a different naming scheme, you would need to define routes explicitly in ``app/Config/Routes.php`` and turn auto-routing off.


Suggested change

If you prefer a different naming scheme, you would need to define routes explicitly in ``app/Config/Routes.php`` and turn auto-routing off.

If you prefer a different naming scheme, you would need to define routes explicitly in **app/Config/Routes.php** and turn auto-routing off.

datamweb · 2025-12-08T07:58:03Z

user_guide_src/source/guides/api/controller.rst

+
+The transormer requires a single method, ``toArray`` to be present and accept a mixed data type called ``$resource``. This method is responsible for transforming the resource into an array format suitable for API responses. The returned array is what is then encoded as JSON or XML for the API response.
+
+Edit the Book transformer at ``app/Transformers/BookTransformer.php``. This one is a little more complex since it includes related author data:


Suggested change

Edit the Book transformer at ``app/Transformers/BookTransformer.php``. This one is a little more complex since it includes related author data:

Edit the Book transformer at **app/Transformers/BookTransformer.php**. This one is a little more complex since it includes related author data:

datamweb · 2025-12-08T08:01:16Z

user_guide_src/source/guides/api/controller.rst

+Implement the remaining methods
+===============================
+
+Edit ``app/Controllers/Api/Book.php`` to include the remaining methods:


Suggested change

Edit ``app/Controllers/Api/Book.php`` to include the remaining methods:

Edit **app/Controllers/Api/Book.php** to include the remaining methods:

datamweb · 2025-12-08T08:15:44Z

user_guide_src/source/guides/api/index.rst

+    database.default.hostname =
+    database.default.port     =
+
+CodeIgniter will automatically create the SQLite database file if it doesn't exist, but you need to ensure that the ``writable/`` directory is writable by the web server.


Suggested change

CodeIgniter will automatically create the SQLite database file if it doesn't exist, but you need to ensure that the ``writable/`` directory is writable by the web server.

CodeIgniter will automatically create the SQLite database file if it doesn't exist, but you need to ensure that the **writable/** directory is writable by the web server.

datamweb · 2025-12-08T08:16:19Z

user_guide_src/source/guides/api/index.rst

+
+- The app starts with ``php spark serve``
+- ``CI_ENVIRONMENT`` is set to ``development`` in ``.env``
+- ``writable/database.db`` exists and is writable


Suggested change

- ``writable/database.db`` exists and is writable

- **writable/database.db** exists and is writable

datamweb · 2025-12-08T08:16:43Z

user_guide_src/source/guides/index.rst

+Guides
+######
+
+This section contains various guides to help you get started with CodeIgniter 4 in a project-based manner.


Suggested change

This section contains various guides to help you get started with CodeIgniter 4 in a project-based manner.

This section contains various guides to help you get started with CodeIgniter4 in a project-based manner.

datamweb · 2025-12-08T08:17:02Z

user_guide_src/source/guides/index.rst

+Build a RESTful API
+*******************
+
+This guide will help you build a simple RESTful API using CodeIgniter 4. You will learn how to use auto-routing, setup controllers, and handle requests and responses in a RESTful manner. By the end of this guide, you will have a functional API that can perform CRUD operations on a resource. This will introduce you to the basic concepts of a RESTful API and the tools that CodeIgniter provides to facilitate its development.


Suggested change

This guide will help you build a simple RESTful API using CodeIgniter 4. You will learn how to use auto-routing, setup controllers, and handle requests and responses in a RESTful manner. By the end of this guide, you will have a functional API that can perform CRUD operations on a resource. This will introduce you to the basic concepts of a RESTful API and the tools that CodeIgniter provides to facilitate its development.

This guide will help you build a simple RESTful API using CodeIgniter4. You will learn how to use auto-routing, setup controllers, and handle requests and responses in a RESTful manner. By the end of this guide, you will have a functional API that can perform CRUD operations on a resource. This will introduce you to the basic concepts of a RESTful API and the tools that CodeIgniter provides to facilitate its development.

datamweb · 2025-12-08T08:18:19Z

user_guide_src/source/index.rst

+*******
+Guides
+*******


Suggested change

*******

Guides

*******

******

Guides

******

Created a new Make an RESTful API guide

b421ff1

lonnieezell changed the title ~~Created a new Make an RESTful API guide~~ docs: Created a new Make an RESTful API guide Nov 21, 2025

cs-fix

55b2458

neznaika0 suggested changes Nov 21, 2025

View reviewed changes

neznaika0 reviewed Nov 22, 2025

View reviewed changes

michalsn reviewed Nov 22, 2025

View reviewed changes

michalsn added documentation Pull requests for documentation only 4.7 labels Nov 30, 2025

datamweb suggested changes Dec 8, 2025

View reviewed changes


		This creates a new file under ``app/Database/Migrations/``.

		Edit the CreateAuthorsTable file to look like this:


		Each author simply has a name for our purposes. We have made the name a uncommented unique key to prevent duplicates.

		Now edit the CreateBooksTable file to look like this:


		The "Improved" auto router is more secure and reliable than the legacy version, so it's recommended for all new projects.

		Then, in ``app/Config/Routing.php`` confirm auto routing is on:


		php spark make:controller Api/Books

		This creates ``app/Controllers/Api/Books.php``.

	This creates ``app/Controllers/Api/Books.php``.
	This creates app/Controllers/Api/Books.php.


		.. tip::

		If you prefer a different naming scheme, you would need to define routes explicitly in ``app/Config/Routes.php`` and turn auto-routing off.


		The transormer requires a single method, ``toArray`` to be present and accept a mixed data type called ``$resource``. This method is responsible for transforming the resource into an array format suitable for API responses. The returned array is what is then encoded as JSON or XML for the API response.

		Edit the Book transformer at ``app/Transformers/BookTransformer.php``. This one is a little more complex since it includes related author data:

	Edit the Book transformer at ``app/Transformers/BookTransformer.php``. This one is a little more complex since it includes related author data:
	Edit the Book transformer at app/Transformers/BookTransformer.php. This one is a little more complex since it includes related author data:

	Edit ``app/Controllers/Api/Book.php`` to include the remaining methods:
	Edit app/Controllers/Api/Book.php to include the remaining methods:

	CodeIgniter will automatically create the SQLite database file if it doesn't exist, but you need to ensure that the ``writable/`` directory is writable by the web server.
	CodeIgniter will automatically create the SQLite database file if it doesn't exist, but you need to ensure that the writable/ directory is writable by the web server.

	- ``writable/database.db`` exists and is writable
	- writable/database.db exists and is writable

	This section contains various guides to help you get started with CodeIgniter 4 in a project-based manner.
	This section contains various guides to help you get started with CodeIgniter4 in a project-based manner.

-*******
-Guides
-*******
+******
+Guides
+******

docs: Created a new Make an RESTful API guide #9808

Are you sure you want to change the base?

docs: Created a new Make an RESTful API guide #9808

Uh oh!

Conversation

lonnieezell commented Nov 21, 2025

Uh oh!

neznaika0 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

neznaika0 commented Nov 22, 2025

Uh oh!

michalsn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants