-
Notifications
You must be signed in to change notification settings - Fork 2k
docs: Create a new Make a RESTful API guide #9808
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.
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
base: 4.7
Are you sure you want to change the base?
Conversation
neznaika0
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Co-authored-by: neznaika0 <[email protected]>
Co-authored-by: neznaika0 <[email protected]> Co-authored-by: Pooya Parsa <[email protected]>
Co-authored-by: Pooya Parsa <[email protected]>
dc813be to
39a9794
Compare
39a9794 to
67c1e76
Compare
|
I have implemented the changes as requested. Please propose changes where necessary. |
Co-authored-by: Pooya Parsa <[email protected]>
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.