docs: Create a new Make a RESTful API guide #9808
Conversation
lonnieezell
changed the title
neznaika0
left a comment
neznaika0
left a comment
There was a problem hiding this comment.
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.
|
You have moved the pages to the directory. Some error correction paths need to be updated. |
michalsn
left a comment
michalsn
left a comment
There was a problem hiding this comment.
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.
paulbalandan
changed the title
paulbalandan
changed the title
Co-authored-by: neznaika0 <ozornick.ks@gmail.com>
Co-authored-by: neznaika0 <ozornick.ks@gmail.com> Co-authored-by: Pooya Parsa <pooya_parsa_dadashi@yahoo.com>
Co-authored-by: Pooya Parsa <pooya_parsa_dadashi@yahoo.com>
paulbalandan
force-pushed
the
api-guide
branch
3 times, most recently
from
dc813be to
39a9794
Compare
paulbalandan
force-pushed
the
api-guide
branch
from
39a9794 to
67c1e76
Compare
|
I have implemented the changes as requested. Please propose changes where necessary. |
| Test the list endpoint | ||
| -------------------------- |
There was a problem hiding this comment.
| Test the list endpoint | |
| -------------------------- | |
| Test the list endpoint | |
| ----------------------- |
| Why Auto-Routing? | ||
| ================== |
There was a problem hiding this comment.
| Why Auto-Routing? | |
| ================== | |
| Why Auto-Routing? | |
| ============= |
|
|
||
| .. code-block:: console | ||
| php spark make:model AuthorModel |
There was a problem hiding this comment.
There is an inconsistency in the model’s table name.
php spark make:model AuthorModel correctly sets the table to authors, which matches CI4 conventions and the existing migrations and seeders.
However, the model currently uses author, causing a mismatch with the database schema. The same issue for Book.
There was a problem hiding this comment.
Thanks. I have based thus change from @neznaika0 's comment and referred to fixture models in tests/_support/Models/ using singular table name. I have forgotten that.
5 participants
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.