Apply suggestions from code review

Co-authored-by: neznaika0 <ozornick.ks@gmail.com>
Co-authored-by: Pooya Parsa <pooya_parsa_dadashi@yahoo.com>

Author: 3 people

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

@@ -6,7 +6,7 @@
 
 class BookModel extends Model
 {
-    protected string $table        = 'books';
+    protected string $table        = 'book';
     protected array $allowedFields = ['title', 'author_id', 'year'];
 
     /**

user_guide_src/source/guides/api/controller.rst

@@ -20,7 +20,7 @@ Run the Spark command:
 
     php spark make:controller Api/Books
 
-This creates ``app/Controllers/Api/Books.php``.
+This creates **app/Controllers/Api/Books.php**.
 
 Open it and replace its contents with the following stubbed out class:
 
@@ -30,7 +30,7 @@ Since we're using auto-routing, we need to use the ``index`` method names so it
 
 .. 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.
+   If you prefer a different naming scheme, you would need to define routes explicitly in **app/Config/Routes.php** and turn auto-routing off.
 
 API Transformers
 =================
@@ -45,7 +45,7 @@ Create the transformers with the generator command:
 
 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:
 
 .. literalinclude:: code/011.php
 
@@ -133,7 +133,7 @@ If you see JSON data from your seeder, congratulations—your API is live!
 Implement the remaining methods
 ===============================
 
-Edit ``app/Controllers/Api/Book.php`` to include the remaining methods:
+Edit **app/Controllers/Api/Book.php** to include the remaining methods:
 
 .. literalinclude:: code/012.php
 
@@ -142,13 +142,13 @@ Each method uses helpers from :php:trait:`ResponseTrait` to send proper HTTP sta
 And that's it! You now have a fully functional RESTful API for managing books, complete with proper HTTP methods, status codes, and data transformation. You can further enhance this API by adding authentication, validation, and other features as needed.
 
 A More Semantic Name scheme
-============================
+===========================
 
 In the previous examples, we used method names like ``getIndex``, ``putIndex``, etc because we wanted to solely rely on the HTTP verb to determine the action. With auto-routing enabled, we have to use the ``index`` method name to avoid conflicts with URI segments. However, if you prefer more semantic method names, you could change the method names so that they reflect the action being performed, such as ``getList``, ``postCreate``, ``putUpdate``, and ``deleteDelete``. This would then make each method's purpose clearer at a glance. And would just add one new segment to the URI.
 
 ```
-GET    /api/book/list        -> getList()
-POST   /api/book/create      -> postCreate()
-PUT    /api/book/update/(:id) -> putUpdate($id)
-DELETE /api/book/delete/(:id) -> deleteDelete($id)
+GET    /api/books/list        -> getList()
+POST   /api/books/create      -> postCreate()
+PUT    /api/books/update/(:id) -> putUpdate($id)
+DELETE /api/books/delete/(:id) -> deleteDelete($id)
 ```

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

@@ -1,7 +1,7 @@
 .. _ci47-rest-part3:
 
 Creating the Database and Model
-################################
+###############################
 
 .. contents::
     :local:
@@ -21,15 +21,15 @@ Run the Spark command:
     php spark make:migration CreateAuthorsTable
     php spark make:migration CreateBooksTable
 
-This creates a new file under ``app/Database/Migrations/``.
+This creates a new file under **app/Database/Migrations/**.
 
 Edit the **CreateAuthorsTable.php** file to look like this:
 
 .. literalinclude:: code/004.php
 
 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:
+Now, edit the **CreateBooksTable.php** file to look like this:
 
 .. literalinclude:: code/005.php
 
@@ -44,7 +44,7 @@ Now run the migration:
 Now the database has the necessary structure to hold our books and authors.
 
 Create a seeder
-================
+===============
 
 Seeders let you load sample data for development so you have something to work with right away. In this case, we’ll create a seeder to add some example books and their authors.
 
@@ -54,7 +54,7 @@ Run:
 
     php spark make:seeder BookSeeder
 
-Edit the file at ``app/Database/Seeds/BookSeeder.php``:
+Edit the file at **app/Database/Seeds/BookSeeder.php**:
 
 .. literalinclude:: code/006.php
 

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

@@ -12,7 +12,7 @@ In this section, we will enable CodeIgniter's *Improved Auto Routing* feature an
 Why Auto-Routing?
 ==================
 
-The previous tutorial introduced you to defined routes manually in ``app/Config/Routes.php``. While this is a powerful and flexible way to define your application's routing, it can be tedious for building RESTful APIs where you may have many endpoints that follow a common pattern. Auto-Routing simplifies this by automatically mapping URL patterns to controller classes and methods based on conventions, and the focus on HTTP verbs works quite well for RESTful APIs.
+The previous tutorial introduced you to defined routes manually in **app/Config/Routes.php**. While this is a powerful and flexible way to define your application's routing, it can be tedious for building RESTful APIs where you may have many endpoints that follow a common pattern. Auto-Routing simplifies this by automatically mapping URL patterns to controller classes and methods based on conventions, and the focus on HTTP verbs works quite well for RESTful APIs.
 
 Enable Improved Auto Routing
 ============================
@@ -36,15 +36,15 @@ Then, in **app/Config/Routing.php** confirm auto-routing is **enabled**:
 That's all you need for CodeIgniter to automatically map your controller classes and to URIs like ``GET /api/ping`` or ``POST /api/ping``.
 
 Create a Ping controller
-=========================
+========================
 
 To understand how a basic API endpoint works, let's generate a controller to serve as our first API endpoint. This will provide a simple "ping" response to confirm our setup is correct.
 
 .. code-block:: console
 
    php spark make:controller Api/Ping
 
-This creates ``app/Controllers/Api/Ping.php``.
+This creates **app/Controllers/Api/Ping.php**.
 
 Edit the file so it looks like this:
 
@@ -100,7 +100,7 @@ Here's how other verbs would map if you added them later:
 +----------------------+--------------------------------+
 
 Content Negotiation with the Format Class
-==========================================
+=========================================
 
 By default, CodeIgniter uses the :php:class:`CodeIgniter\\Format\\Format` class to automatically negotiate the response format. It can return responses in either JSON or XML depending on what the client requests.
 

user_guide_src/source/guides/api/index.rst

@@ -7,7 +7,7 @@ Getting Started with REST APIs
     :local:
     :depth: 2
 
-This tutorial will guide you through building a simple RESTful API to manage books using Codeigniter 4. Along the way, you'll leanr the basics of setting up a CodeIgniter project, configuring a database, and creating API endpoints, as well as understand what makes a RESTful API.
+This tutorial will guide you through building a simple RESTful API to manage books using Codeigniter4. Along the way, you'll leanr the basics of setting up a CodeIgniter project, configuring a database, and creating API endpoints, as well as understand what makes a RESTful API.
 
 This tutorial will primarily focus on:
 
@@ -85,7 +85,7 @@ Open ``.env`` and **uncomment** the database section, then set:
     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.
+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.
 
 .. warning::
 
@@ -96,7 +96,7 @@ At this point, you should have a working CodeIgniter 4 project with SQLite confi
 
 - The app starts with ``php spark serve``
 - ``CI_ENVIRONMENT`` is set to ``development`` in ``.env``
-- ``writable/database.db`` exists and is writable
+- **writable/database.db** exists and is writable
 
 What's next
 ===========

user_guide_src/source/guides/index.rst

@@ -2,7 +2,7 @@
 Guides
 ######
 
-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.
 
 .. toctree::
    :titlesonly:
@@ -20,4 +20,4 @@ This project walks you through building a basic news application. You will begin
 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.
+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.

user_guide_src/source/index.rst

@@ -18,9 +18,9 @@ Getting Started
 
     installation/index
 
-*******
+******
 Guides
-*******
+******
 
 .. toctree::
     :includehidden: