Docs: developer guide for building a module REST API#6
Merged
Conversation
Worked HRM example covering where API controllers and routes live, the api.json + Sanctum setup and tenant scoping, the two gotchas (no route-model binding, apiResource name collisions), ApiFormRequest validation, scoped Scramble docs registration, and verifying with scramble:analyze + route:cache.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes zerp-pk/zerp#35. New Developer > Guides page walking through adding a REST API to a module, HRM as the worked example: controller/route layout, api.json + Sanctum + tenant scoping, the no-route-model-binding and apiResource-collision gotchas, ApiFormRequest validation, Scramble::registerApi, and verifying with scramble:analyze + route:cache.