Added shared_params helper
#5
Open
Conversation
This file contains 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
stgeneral
requested changes
May 6, 2019
| @@ -14,6 +14,7 @@ API is an important part of web applications. They provide interfaces for commun | |||
| * Each API resource class (e.g. `UsersResource`) defines a single resource (e.g. `resource :users do ... end`). | |||
| * Entities are stored in `entities/` directory and inherited from `Grape::Entity` class. | |||
| * Each API resource, entity class or helpers module class are wrapped into corresponding module (e.g. `AppV1API::Resources`, `AppV1API::Entities`, `AppV1API::Helpers`). | |||
| * For duplicate params across the project use special `SharedParamsHelper` helper. | |||
There was a problem hiding this comment.
- This sentence is not very English ;)
- It is useful for sharing params between several API resources. If params are shared between "actions" of the same resources then it is better to keep them inside the resource.
Probbly, something like this will sound a bit better:
"SharedParamsHelper helper may be used to share params between resources."
| extend Grape::API::Helpers | ||
|
|
||
| params :user do | ||
| # List of API params, for reusing |
|
|
||
| resource :user do | ||
| params do | ||
| use :user # Call `params` which set at SharedParamsHelper |
There was a problem hiding this comment.
- Call -> invokes
- which set - > which is defined
stgeneral
changed the base branch from
feature/api-guide-refactoring
to
develop
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.