Skip to content

docs: class defined as "Ping" but endpoints trying to fetch "Pings" #10033

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cjbaezilla wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

docs: class defined as "Ping" but endpoints trying to fetch "Pings" #10033

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions user_guide_src/source/guides/api/first-endpoint.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Then, in **app/Config/Routing.php**, confirm auto-routing is **enabled**:

public bool $autoRoute = true;

That's all you need for CodeIgniter to automatically map your controller classes and to URIs like ``GET /api/pings`` or ``POST /api/pings``.
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
========================
Expand All @@ -53,7 +53,7 @@ Edit the file so it looks like this:
Here we:

- Use the :php:class:`ResponseTrait`, which already includes REST helpers such as :php:meth:`respond()` and proper status codes.
- Define a ``getIndex()`` method. The ``get`` prefix means it responds to ``GET`` requests, and the ``Index`` name means it matches the base URI (``/api/pings``).
- Define a ``getIndex()`` method. The ``get`` prefix means it responds to ``GET`` requests, and the ``Index`` name means it matches the base URI (``/api/ping``).

Test the route
==============
Expand All @@ -66,8 +66,8 @@ Start the development server if it isn't running:

Now visit:

- **Browser:** ``http://localhost:8080/api/pings``
- **cURL:** ``curl http://localhost:8080/api/pings``
- **Browser:** ``http://localhost:8080/api/ping``
- **cURL:** ``curl http://localhost:8080/api/ping``

Expected response:

Expand All @@ -82,9 +82,9 @@ Congratulations — that's your first working JSON endpoint!
Understand how it works
=======================

When you request ``/api/pings``:
When you request ``/api/ping``:

1. The **Improved Auto Router** finds the ``App\Controllers\Api\Pings`` class.
1. The **Improved Auto Router** finds the ``App\Controllers\Api\Ping`` class.
2. It detects the HTTP verb (``GET``).
3. It calls the corresponding method name: ``getIndex()``.
4. :php:trait:`ResponseTrait` provides helper methods to produce consistent output.
Expand All @@ -94,9 +94,9 @@ Here's how other verbs would map if you added them later:
+-----------------------+--------------------------------+
| HTTP Verb | Method Name |
+=======================+================================+
| ``GET /api/pings`` | ``getIndex()`` |
| ``POST /api/pings`` | ``postIndex()`` |
| ``DELETE /api/pings`` | ``deleteIndex()`` |
| ``GET /api/ping`` | ``getIndex()`` |
| ``POST /api/ping`` | ``postIndex()`` |
| ``DELETE /api/ping`` | ``deleteIndex()`` |
+-----------------------+--------------------------------+

Content Negotiation with the Format Class
Expand Down
Loading