agi_active_model_serializers 0.10.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.github/ISSUE_TEMPLATE.md +29 -0
- data/.github/PULL_REQUEST_TEMPLATE.md +15 -0
- data/.gitignore +35 -0
- data/.rubocop.yml +102 -0
- data/.simplecov +110 -0
- data/.travis.yml +51 -0
- data/CHANGELOG.md +612 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/CONTRIBUTING.md +105 -0
- data/Gemfile +56 -0
- data/MIT-LICENSE +22 -0
- data/README.md +307 -0
- data/Rakefile +103 -0
- data/active_model_serializers.gemspec +63 -0
- data/appveyor.yml +24 -0
- data/bin/bench +171 -0
- data/bin/bench_regression +316 -0
- data/bin/serve_benchmark +39 -0
- data/docs/README.md +41 -0
- data/docs/STYLE.md +58 -0
- data/docs/general/adapters.md +247 -0
- data/docs/general/caching.md +58 -0
- data/docs/general/configuration_options.md +169 -0
- data/docs/general/deserialization.md +100 -0
- data/docs/general/fields.md +31 -0
- data/docs/general/getting_started.md +133 -0
- data/docs/general/instrumentation.md +40 -0
- data/docs/general/key_transforms.md +40 -0
- data/docs/general/logging.md +14 -0
- data/docs/general/rendering.md +279 -0
- data/docs/general/serializers.md +461 -0
- data/docs/how-open-source-maintained.jpg +0 -0
- data/docs/howto/add_pagination_links.md +138 -0
- data/docs/howto/add_relationship_links.md +137 -0
- data/docs/howto/add_root_key.md +55 -0
- data/docs/howto/grape_integration.md +42 -0
- data/docs/howto/outside_controller_use.md +65 -0
- data/docs/howto/passing_arbitrary_options.md +27 -0
- data/docs/howto/serialize_poro.md +32 -0
- data/docs/howto/test.md +154 -0
- data/docs/howto/upgrade_from_0_8_to_0_10.md +265 -0
- data/docs/integrations/ember-and-json-api.md +144 -0
- data/docs/integrations/grape.md +19 -0
- data/docs/jsonapi/errors.md +56 -0
- data/docs/jsonapi/schema.md +151 -0
- data/docs/jsonapi/schema/schema.json +366 -0
- data/docs/rfcs/0000-namespace.md +106 -0
- data/docs/rfcs/template.md +15 -0
- data/lib/action_controller/serialization.rb +66 -0
- data/lib/active_model/serializable_resource.rb +11 -0
- data/lib/active_model/serializer.rb +231 -0
- data/lib/active_model/serializer/adapter.rb +24 -0
- data/lib/active_model/serializer/adapter/attributes.rb +15 -0
- data/lib/active_model/serializer/adapter/base.rb +18 -0
- data/lib/active_model/serializer/adapter/json.rb +15 -0
- data/lib/active_model/serializer/adapter/json_api.rb +15 -0
- data/lib/active_model/serializer/adapter/null.rb +15 -0
- data/lib/active_model/serializer/array_serializer.rb +12 -0
- data/lib/active_model/serializer/association.rb +34 -0
- data/lib/active_model/serializer/attribute.rb +25 -0
- data/lib/active_model/serializer/belongs_to_reflection.rb +7 -0
- data/lib/active_model/serializer/collection_reflection.rb +7 -0
- data/lib/active_model/serializer/collection_serializer.rb +87 -0
- data/lib/active_model/serializer/concerns/associations.rb +102 -0
- data/lib/active_model/serializer/concerns/attributes.rb +82 -0
- data/lib/active_model/serializer/concerns/caching.rb +292 -0
- data/lib/active_model/serializer/concerns/configuration.rb +59 -0
- data/lib/active_model/serializer/concerns/links.rb +35 -0
- data/lib/active_model/serializer/concerns/meta.rb +29 -0
- data/lib/active_model/serializer/concerns/type.rb +25 -0
- data/lib/active_model/serializer/error_serializer.rb +14 -0
- data/lib/active_model/serializer/errors_serializer.rb +32 -0
- data/lib/active_model/serializer/field.rb +90 -0
- data/lib/active_model/serializer/fieldset.rb +31 -0
- data/lib/active_model/serializer/has_many_reflection.rb +7 -0
- data/lib/active_model/serializer/has_one_reflection.rb +7 -0
- data/lib/active_model/serializer/lint.rb +150 -0
- data/lib/active_model/serializer/null.rb +17 -0
- data/lib/active_model/serializer/reflection.rb +163 -0
- data/lib/active_model/serializer/singular_reflection.rb +7 -0
- data/lib/active_model/serializer/version.rb +5 -0
- data/lib/active_model_serializers.rb +53 -0
- data/lib/active_model_serializers/adapter.rb +98 -0
- data/lib/active_model_serializers/adapter/attributes.rb +13 -0
- data/lib/active_model_serializers/adapter/base.rb +83 -0
- data/lib/active_model_serializers/adapter/json.rb +21 -0
- data/lib/active_model_serializers/adapter/json_api.rb +517 -0
- data/lib/active_model_serializers/adapter/json_api/deserialization.rb +213 -0
- data/lib/active_model_serializers/adapter/json_api/error.rb +96 -0
- data/lib/active_model_serializers/adapter/json_api/jsonapi.rb +49 -0
- data/lib/active_model_serializers/adapter/json_api/link.rb +83 -0
- data/lib/active_model_serializers/adapter/json_api/meta.rb +37 -0
- data/lib/active_model_serializers/adapter/json_api/pagination_links.rb +69 -0
- data/lib/active_model_serializers/adapter/json_api/relationship.rb +63 -0
- data/lib/active_model_serializers/adapter/json_api/resource_identifier.rb +51 -0
- data/lib/active_model_serializers/adapter/null.rb +9 -0
- data/lib/active_model_serializers/callbacks.rb +55 -0
- data/lib/active_model_serializers/deprecate.rb +54 -0
- data/lib/active_model_serializers/deserialization.rb +15 -0
- data/lib/active_model_serializers/json_pointer.rb +14 -0
- data/lib/active_model_serializers/logging.rb +122 -0
- data/lib/active_model_serializers/lookup_chain.rb +80 -0
- data/lib/active_model_serializers/model.rb +71 -0
- data/lib/active_model_serializers/railtie.rb +48 -0
- data/lib/active_model_serializers/register_jsonapi_renderer.rb +78 -0
- data/lib/active_model_serializers/serializable_resource.rb +82 -0
- data/lib/active_model_serializers/serialization_context.rb +39 -0
- data/lib/active_model_serializers/test.rb +7 -0
- data/lib/active_model_serializers/test/schema.rb +138 -0
- data/lib/active_model_serializers/test/serializer.rb +125 -0
- data/lib/generators/rails/USAGE +6 -0
- data/lib/generators/rails/resource_override.rb +10 -0
- data/lib/generators/rails/serializer_generator.rb +36 -0
- data/lib/generators/rails/templates/serializer.rb.erb +15 -0
- data/lib/grape/active_model_serializers.rb +16 -0
- data/lib/grape/formatters/active_model_serializers.rb +32 -0
- data/lib/grape/helpers/active_model_serializers.rb +17 -0
- data/test/action_controller/adapter_selector_test.rb +53 -0
- data/test/action_controller/explicit_serializer_test.rb +135 -0
- data/test/action_controller/json/include_test.rb +246 -0
- data/test/action_controller/json_api/deserialization_test.rb +112 -0
- data/test/action_controller/json_api/errors_test.rb +40 -0
- data/test/action_controller/json_api/fields_test.rb +66 -0
- data/test/action_controller/json_api/linked_test.rb +202 -0
- data/test/action_controller/json_api/pagination_test.rb +116 -0
- data/test/action_controller/json_api/transform_test.rb +189 -0
- data/test/action_controller/lookup_proc_test.rb +49 -0
- data/test/action_controller/namespace_lookup_test.rb +232 -0
- data/test/action_controller/serialization_scope_name_test.rb +229 -0
- data/test/action_controller/serialization_test.rb +472 -0
- data/test/active_model_serializers/adapter_for_test.rb +208 -0
- data/test/active_model_serializers/json_pointer_test.rb +22 -0
- data/test/active_model_serializers/logging_test.rb +77 -0
- data/test/active_model_serializers/model_test.rb +69 -0
- data/test/active_model_serializers/railtie_test_isolated.rb +63 -0
- data/test/active_model_serializers/register_jsonapi_renderer_test_isolated.rb +161 -0
- data/test/active_model_serializers/serialization_context_test_isolated.rb +71 -0
- data/test/active_model_serializers/test/schema_test.rb +131 -0
- data/test/active_model_serializers/test/serializer_test.rb +62 -0
- data/test/active_record_test.rb +9 -0
- data/test/adapter/attributes_test.rb +43 -0
- data/test/adapter/deprecation_test.rb +100 -0
- data/test/adapter/json/belongs_to_test.rb +45 -0
- data/test/adapter/json/collection_test.rb +104 -0
- data/test/adapter/json/has_many_test.rb +45 -0
- data/test/adapter/json/transform_test.rb +93 -0
- data/test/adapter/json_api/belongs_to_test.rb +155 -0
- data/test/adapter/json_api/collection_test.rb +96 -0
- data/test/adapter/json_api/errors_test.rb +76 -0
- data/test/adapter/json_api/fields_test.rb +96 -0
- data/test/adapter/json_api/has_many_embed_ids_test.rb +43 -0
- data/test/adapter/json_api/has_many_explicit_serializer_test.rb +96 -0
- data/test/adapter/json_api/has_many_test.rb +165 -0
- data/test/adapter/json_api/has_one_test.rb +80 -0
- data/test/adapter/json_api/include_data_if_sideloaded_test.rb +168 -0
- data/test/adapter/json_api/json_api_test.rb +33 -0
- data/test/adapter/json_api/linked_test.rb +413 -0
- data/test/adapter/json_api/links_test.rb +95 -0
- data/test/adapter/json_api/pagination_links_test.rb +193 -0
- data/test/adapter/json_api/parse_test.rb +137 -0
- data/test/adapter/json_api/relationship_test.rb +397 -0
- data/test/adapter/json_api/resource_identifier_test.rb +110 -0
- data/test/adapter/json_api/resource_meta_test.rb +100 -0
- data/test/adapter/json_api/toplevel_jsonapi_test.rb +82 -0
- data/test/adapter/json_api/transform_test.rb +512 -0
- data/test/adapter/json_api/type_test.rb +61 -0
- data/test/adapter/json_test.rb +46 -0
- data/test/adapter/null_test.rb +22 -0
- data/test/adapter/polymorphic_test.rb +171 -0
- data/test/adapter_test.rb +67 -0
- data/test/array_serializer_test.rb +22 -0
- data/test/benchmark/app.rb +65 -0
- data/test/benchmark/benchmarking_support.rb +67 -0
- data/test/benchmark/bm_active_record.rb +81 -0
- data/test/benchmark/bm_adapter.rb +38 -0
- data/test/benchmark/bm_caching.rb +119 -0
- data/test/benchmark/bm_lookup_chain.rb +83 -0
- data/test/benchmark/bm_transform.rb +45 -0
- data/test/benchmark/config.ru +3 -0
- data/test/benchmark/controllers.rb +83 -0
- data/test/benchmark/fixtures.rb +219 -0
- data/test/cache_test.rb +595 -0
- data/test/collection_serializer_test.rb +123 -0
- data/test/fixtures/active_record.rb +113 -0
- data/test/fixtures/poro.rb +232 -0
- data/test/generators/scaffold_controller_generator_test.rb +24 -0
- data/test/generators/serializer_generator_test.rb +74 -0
- data/test/grape_test.rb +178 -0
- data/test/lint_test.rb +49 -0
- data/test/logger_test.rb +20 -0
- data/test/poro_test.rb +9 -0
- data/test/serializable_resource_test.rb +79 -0
- data/test/serializers/association_macros_test.rb +37 -0
- data/test/serializers/associations_test.rb +383 -0
- data/test/serializers/attribute_test.rb +153 -0
- data/test/serializers/attributes_test.rb +52 -0
- data/test/serializers/caching_configuration_test_isolated.rb +170 -0
- data/test/serializers/configuration_test.rb +32 -0
- data/test/serializers/fieldset_test.rb +14 -0
- data/test/serializers/meta_test.rb +202 -0
- data/test/serializers/options_test.rb +32 -0
- data/test/serializers/read_attribute_for_serialization_test.rb +79 -0
- data/test/serializers/root_test.rb +21 -0
- data/test/serializers/serialization_test.rb +55 -0
- data/test/serializers/serializer_for_test.rb +136 -0
- data/test/serializers/serializer_for_with_namespace_test.rb +88 -0
- data/test/support/custom_schemas/active_model_serializers/test/schema_test/my/index.json +6 -0
- data/test/support/isolated_unit.rb +82 -0
- data/test/support/rails5_shims.rb +53 -0
- data/test/support/rails_app.rb +36 -0
- data/test/support/schemas/active_model_serializers/test/schema_test/my/index.json +6 -0
- data/test/support/schemas/active_model_serializers/test/schema_test/my/show.json +6 -0
- data/test/support/schemas/custom/show.json +7 -0
- data/test/support/schemas/hyper_schema.json +93 -0
- data/test/support/schemas/render_using_json_api.json +43 -0
- data/test/support/schemas/simple_json_pointers.json +10 -0
- data/test/support/serialization_testing.rb +71 -0
- data/test/test_helper.rb +58 -0
- metadata +602 -0
Binary file
|
@@ -0,0 +1,138 @@
|
|
1
|
+
[Back to Guides](../README.md)
|
2
|
+
|
3
|
+
# How to add pagination links
|
4
|
+
|
5
|
+
### JSON API adapter
|
6
|
+
|
7
|
+
Pagination links will be included in your response automatically as long as
|
8
|
+
the resource is paginated and if you are using the ```JsonApi``` adapter.
|
9
|
+
|
10
|
+
If you want pagination links in your response, use [Kaminari](https://github.com/amatsuda/kaminari)
|
11
|
+
or [WillPaginate](https://github.com/mislav/will_paginate).
|
12
|
+
|
13
|
+
Although the other adapters do not have this feature, it is possible to
|
14
|
+
implement pagination links to `JSON` adapter. For more information about it,
|
15
|
+
please check our docs.
|
16
|
+
|
17
|
+
###### Kaminari examples
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
#array
|
21
|
+
@posts = Kaminari.paginate_array([1, 2, 3]).page(3).per(1)
|
22
|
+
render json: @posts
|
23
|
+
|
24
|
+
#active_record
|
25
|
+
@posts = Post.page(3).per(1)
|
26
|
+
render json: @posts
|
27
|
+
```
|
28
|
+
|
29
|
+
###### WillPaginate examples
|
30
|
+
|
31
|
+
```ruby
|
32
|
+
#array
|
33
|
+
@posts = [1,2,3].paginate(page: 3, per_page: 1)
|
34
|
+
render json: @posts
|
35
|
+
|
36
|
+
#active_record
|
37
|
+
@posts = Post.page(3).per_page(1)
|
38
|
+
render json: @posts
|
39
|
+
```
|
40
|
+
|
41
|
+
```ruby
|
42
|
+
ActiveModelSerializers.config.adapter = :json_api
|
43
|
+
```
|
44
|
+
|
45
|
+
ex:
|
46
|
+
```json
|
47
|
+
{
|
48
|
+
"data": [
|
49
|
+
{
|
50
|
+
"type": "articles",
|
51
|
+
"id": "3",
|
52
|
+
"attributes": {
|
53
|
+
"title": "JSON API paints my bikeshed!",
|
54
|
+
"body": "The shortest article. Ever.",
|
55
|
+
"created": "2015-05-22T14:56:29.000Z",
|
56
|
+
"updated": "2015-05-22T14:56:28.000Z"
|
57
|
+
}
|
58
|
+
}
|
59
|
+
],
|
60
|
+
"links": {
|
61
|
+
"self": "http://example.com/articles?page[number]=3&page[size]=1",
|
62
|
+
"first": "http://example.com/articles?page[number]=1&page[size]=1",
|
63
|
+
"prev": "http://example.com/articles?page[number]=2&page[size]=1",
|
64
|
+
"next": "http://example.com/articles?page[number]=4&page[size]=1",
|
65
|
+
"last": "http://example.com/articles?page[number]=13&page[size]=1"
|
66
|
+
}
|
67
|
+
}
|
68
|
+
```
|
69
|
+
|
70
|
+
ActiveModelSerializers pagination relies on a paginated collection with the methods `current_page`, `total_pages`, and `size`, such as are supported by both [Kaminari](https://github.com/amatsuda/kaminari) or [WillPaginate](https://github.com/mislav/will_paginate).
|
71
|
+
|
72
|
+
|
73
|
+
### JSON adapter
|
74
|
+
|
75
|
+
If you are using `JSON` adapter, pagination links will not be included automatically, but it is possible to do so using `meta` key.
|
76
|
+
|
77
|
+
Add this method to your base API controller.
|
78
|
+
|
79
|
+
```ruby
|
80
|
+
def pagination_dict(object)
|
81
|
+
{
|
82
|
+
current_page: object.current_page,
|
83
|
+
next_page: object.next_page,
|
84
|
+
prev_page: object.prev_page, # use object.previous_page when using will_paginate
|
85
|
+
total_pages: object.total_pages,
|
86
|
+
total_count: object.total_count
|
87
|
+
}
|
88
|
+
end
|
89
|
+
```
|
90
|
+
|
91
|
+
Then, use it on your render method.
|
92
|
+
|
93
|
+
```ruby
|
94
|
+
render json: posts, meta: pagination_dict(posts)
|
95
|
+
```
|
96
|
+
|
97
|
+
ex.
|
98
|
+
```json
|
99
|
+
{
|
100
|
+
"posts": [
|
101
|
+
{
|
102
|
+
"id": 2,
|
103
|
+
"title": "JSON API paints my bikeshed!",
|
104
|
+
"body": "The shortest article. Ever."
|
105
|
+
}
|
106
|
+
],
|
107
|
+
"meta": {
|
108
|
+
"current_page": 3,
|
109
|
+
"next_page": 4,
|
110
|
+
"prev_page": 2,
|
111
|
+
"total_pages": 10,
|
112
|
+
"total_count": 10
|
113
|
+
}
|
114
|
+
}
|
115
|
+
```
|
116
|
+
|
117
|
+
You can also achieve the same result if you have a helper method that adds the pagination info in the meta tag. For instance, in your action specify a custom serializer.
|
118
|
+
|
119
|
+
```ruby
|
120
|
+
render json: @posts, each_serializer: PostPreviewSerializer, meta: meta_attributes(@post)
|
121
|
+
```
|
122
|
+
|
123
|
+
```ruby
|
124
|
+
#expects pagination!
|
125
|
+
def meta_attributes(resource, extra_meta = {})
|
126
|
+
{
|
127
|
+
current_page: resource.current_page,
|
128
|
+
next_page: resource.next_page,
|
129
|
+
prev_page: resource.prev_page, # use resource.previous_page when using will_paginate
|
130
|
+
total_pages: resource.total_pages,
|
131
|
+
total_count: resource.total_count
|
132
|
+
}.merge(extra_meta)
|
133
|
+
end
|
134
|
+
```
|
135
|
+
|
136
|
+
### Attributes adapter
|
137
|
+
|
138
|
+
This adapter does not allow us to use `meta` key, due to that it is not possible to add pagination links.
|
@@ -0,0 +1,137 @@
|
|
1
|
+
[Back to Guides](../README.md)
|
2
|
+
|
3
|
+
# How to add relationship links
|
4
|
+
|
5
|
+
ActiveModelSerializers offers you many ways to add links in your JSON, depending on your needs.
|
6
|
+
The most common use case for links is supporting nested resources.
|
7
|
+
|
8
|
+
The following examples are without included relationship data (`include` param is empty),
|
9
|
+
specifically the following Rails controller was used for these examples:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
class Api::V1::UsersController < ApplicationController
|
13
|
+
def show
|
14
|
+
render jsonapi: User.find(params[:id]),
|
15
|
+
serializer: Api::V1::UserSerializer,
|
16
|
+
include: []
|
17
|
+
end
|
18
|
+
```
|
19
|
+
|
20
|
+
Bear in mind though that ActiveModelSerializers are [framework-agnostic](outside_controller_use.md), Rails is just a common example here.
|
21
|
+
|
22
|
+
### Links as an attribute of a resource
|
23
|
+
**This is applicable to JSONAPI, JSON and Attributes adapters**
|
24
|
+
|
25
|
+
You can define an attribute in the resource, named `links`.
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
class Api::V1::UserSerializer < ActiveModel::Serializer
|
29
|
+
attributes :id, :name, :links
|
30
|
+
|
31
|
+
def links
|
32
|
+
{
|
33
|
+
self: api_v1_user_path(object.id),
|
34
|
+
microposts: api_v1_microposts_path(user_id: object.id)
|
35
|
+
}
|
36
|
+
end
|
37
|
+
end
|
38
|
+
```
|
39
|
+
|
40
|
+
This will result in (example is in JSONAPI adapter):
|
41
|
+
```json
|
42
|
+
{
|
43
|
+
"data": {
|
44
|
+
"id": "1",
|
45
|
+
"type": "users",
|
46
|
+
"attributes": {
|
47
|
+
"name": "Example User",
|
48
|
+
"links": {
|
49
|
+
"self": "/api/v1/users/1",
|
50
|
+
"microposts": "/api/v1/microposts?user_id=1"
|
51
|
+
}
|
52
|
+
}
|
53
|
+
}
|
54
|
+
}
|
55
|
+
```
|
56
|
+
|
57
|
+
|
58
|
+
### Links as a property of the resource definiton
|
59
|
+
**This is only applicable to JSONAPI adapter**
|
60
|
+
|
61
|
+
You can use the `links` class method to define the links you need in the resource's primary data.
|
62
|
+
|
63
|
+
```ruby
|
64
|
+
class Api::V1::UserSerializer < ActiveModel::Serializer
|
65
|
+
attributes :id, :name
|
66
|
+
|
67
|
+
link(:self) { api_v1_user_path(object.id) }
|
68
|
+
link(:microposts) { api_v1_microposts_path(user_id: object.id) }
|
69
|
+
end
|
70
|
+
```
|
71
|
+
|
72
|
+
This will result in (example is in JSONAPI adapter):
|
73
|
+
```json
|
74
|
+
{
|
75
|
+
"data": {
|
76
|
+
"id": "1",
|
77
|
+
"type": "users",
|
78
|
+
"attributes": {
|
79
|
+
"name": "Example User"
|
80
|
+
},
|
81
|
+
"links": {
|
82
|
+
"self": "/api/v1/users/1",
|
83
|
+
"microposts": "/api/v1/microposts?user_id=1"
|
84
|
+
}
|
85
|
+
}
|
86
|
+
}
|
87
|
+
```
|
88
|
+
|
89
|
+
### Links that follow the JSONAPI spec
|
90
|
+
**This is only applicable to JSONAPI adapter**
|
91
|
+
|
92
|
+
If you have a JSONAPI-strict client that you are working with (like `ember-data`)
|
93
|
+
you need to construct the links inside the relationships. Also the link to fetch the
|
94
|
+
relationship data must be under the `related` attribute, whereas to manipulate the
|
95
|
+
relationship (in case of many-to-many relationship) must be under the `self` attribute.
|
96
|
+
|
97
|
+
You can find more info in the [spec](http://jsonapi.org/format/#document-resource-object-relationships).
|
98
|
+
|
99
|
+
Here is how you can do this:
|
100
|
+
|
101
|
+
```ruby
|
102
|
+
class Api::V1::UserSerializer < ActiveModel::Serializer
|
103
|
+
attributes :id, :name
|
104
|
+
|
105
|
+
has_many :microposts, serializer: Api::V1::MicropostSerializer do
|
106
|
+
link(:related) { api_v1_microposts_path(user_id: object.id) }
|
107
|
+
end
|
108
|
+
|
109
|
+
#this is needed to avoid n+1, gem core devs are working to remove this necessity
|
110
|
+
#more on: https://github.com/rails-api/active_model_serializers/issues/1325
|
111
|
+
def microposts
|
112
|
+
object.microposts.loaded ? object.microposts : object.microposts.none
|
113
|
+
end
|
114
|
+
end
|
115
|
+
```
|
116
|
+
|
117
|
+
This will result in:
|
118
|
+
|
119
|
+
```json
|
120
|
+
{
|
121
|
+
"data": {
|
122
|
+
"id": "1",
|
123
|
+
"type": "users",
|
124
|
+
"attributes": {
|
125
|
+
"name": "Example User"
|
126
|
+
},
|
127
|
+
"relationships": {
|
128
|
+
"microposts": {
|
129
|
+
"data": [],
|
130
|
+
"links": {
|
131
|
+
"related": "/api/v1/microposts?user_id=1"
|
132
|
+
}
|
133
|
+
}
|
134
|
+
}
|
135
|
+
}
|
136
|
+
}
|
137
|
+
```
|
@@ -0,0 +1,55 @@
|
|
1
|
+
[Back to Guides](../README.md)
|
2
|
+
|
3
|
+
# How to add root key
|
4
|
+
|
5
|
+
Add the root key to your API is quite simple with ActiveModelSerializers. The **Adapter** is what determines the format of your JSON response. The default adapter is the ```Attributes``` which doesn't have the root key, so your response is something similar to:
|
6
|
+
|
7
|
+
```json
|
8
|
+
{
|
9
|
+
"id": 1,
|
10
|
+
"title": "Awesome Post Tile",
|
11
|
+
"content": "Post content"
|
12
|
+
}
|
13
|
+
```
|
14
|
+
|
15
|
+
In order to add the root key you need to use the ```JSON``` Adapter, you can change this in an initializer:
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
ActiveModelSerializers.config.adapter = :json
|
19
|
+
```
|
20
|
+
|
21
|
+
You can also specify a class as adapter, as long as it complies with the ActiveModelSerializers adapters interface.
|
22
|
+
It will add the root key to all your serialized endpoints.
|
23
|
+
|
24
|
+
ex:
|
25
|
+
|
26
|
+
```json
|
27
|
+
{
|
28
|
+
"post": {
|
29
|
+
"id": 1,
|
30
|
+
"title": "Awesome Post Tile",
|
31
|
+
"content": "Post content"
|
32
|
+
}
|
33
|
+
}
|
34
|
+
```
|
35
|
+
|
36
|
+
or if it returns a collection:
|
37
|
+
|
38
|
+
```json
|
39
|
+
{
|
40
|
+
"posts": [
|
41
|
+
{
|
42
|
+
"id": 1,
|
43
|
+
"title": "Awesome Post Tile",
|
44
|
+
"content": "Post content"
|
45
|
+
},
|
46
|
+
{
|
47
|
+
"id": 2,
|
48
|
+
"title": "Another Post Tile",
|
49
|
+
"content": "Another post content"
|
50
|
+
}
|
51
|
+
]
|
52
|
+
}
|
53
|
+
```
|
54
|
+
|
55
|
+
[There are several ways to specify root](../general/serializers.md#root) when using the JSON adapter.
|
@@ -0,0 +1,42 @@
|
|
1
|
+
[Back to Guides](../README.md)
|
2
|
+
|
3
|
+
The ActiveModelSerializers grape formatter relies on the existence of `env['grape.request']` which is implemeted by `Grape::Middleware::Globals`. You can meet his dependency by calling it before mounting the endpoints.
|
4
|
+
|
5
|
+
In the simpliest way:
|
6
|
+
|
7
|
+
```
|
8
|
+
class API < Grape::API
|
9
|
+
# @note Make sure this is above you're first +mount+
|
10
|
+
use Grape::Middleware::Globals
|
11
|
+
end
|
12
|
+
```
|
13
|
+
|
14
|
+
or more like what is shown in current Grape tutorials:
|
15
|
+
|
16
|
+
```
|
17
|
+
module MyApi
|
18
|
+
class ApiBase < Grape::API
|
19
|
+
use Grape::Middleware::Globals
|
20
|
+
|
21
|
+
require 'grape/active_model_serializers'
|
22
|
+
include Grape::ActiveModelSerializers
|
23
|
+
|
24
|
+
mount MyApi::V1::ApiBase
|
25
|
+
end
|
26
|
+
end
|
27
|
+
```
|
28
|
+
|
29
|
+
You could meet this dependency with your own middleware. The invocation might look like:
|
30
|
+
|
31
|
+
```
|
32
|
+
module MyApi
|
33
|
+
class ApiBase < Grape::API
|
34
|
+
use My::Middleware::Thingamabob
|
35
|
+
|
36
|
+
require 'grape/active_model_serializers'
|
37
|
+
include Grape::ActiveModelSerializers
|
38
|
+
|
39
|
+
mount MyApi::V1::ApiBase
|
40
|
+
end
|
41
|
+
end
|
42
|
+
```
|
@@ -0,0 +1,65 @@
|
|
1
|
+
[Back to Guides](../README.md)
|
2
|
+
|
3
|
+
## Using ActiveModelSerializers Outside Of A Controller
|
4
|
+
|
5
|
+
### Serializing a resource
|
6
|
+
|
7
|
+
In ActiveModelSerializers versions 0.10 or later, serializing resources outside of the controller context is fairly simple:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
# Create our resource
|
11
|
+
post = Post.create(title: "Sample post", body: "I love Active Model Serializers!")
|
12
|
+
|
13
|
+
# Optional options parameters
|
14
|
+
options = {}
|
15
|
+
|
16
|
+
# Create a serializable resource instance
|
17
|
+
serializable_resource = ActiveModelSerializers::SerializableResource.new(post, options)
|
18
|
+
|
19
|
+
# Convert your resource into json
|
20
|
+
model_json = serializable_resource.as_json
|
21
|
+
```
|
22
|
+
The object that is passed to `ActiveModelSerializers::SerializableResource.new` can be a single resource or a collection.
|
23
|
+
|
24
|
+
### Looking up the Serializer for a Resource
|
25
|
+
|
26
|
+
If you want to retrieve the serializer class for a specific resource, you can do the following:
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
# Create our resource
|
30
|
+
post = Post.create(title: "Another Example", body: "So much fun.")
|
31
|
+
|
32
|
+
# Optional options parameters
|
33
|
+
options = {}
|
34
|
+
|
35
|
+
# Retrieve the default serializer for posts
|
36
|
+
serializer = ActiveModel::Serializer.serializer_for(post, options)
|
37
|
+
```
|
38
|
+
|
39
|
+
You could also retrieve the serializer via:
|
40
|
+
|
41
|
+
```ruby
|
42
|
+
ActiveModelSerializers::SerializableResource.new(post, options).serializer
|
43
|
+
```
|
44
|
+
|
45
|
+
Both approaches will return the serializer class that will be used for the resource.
|
46
|
+
|
47
|
+
Additionally, you could retrieve the serializer instance for the resource via:
|
48
|
+
|
49
|
+
```ruby
|
50
|
+
ActiveModelSerializers::SerializableResource.new(post, options).serializer_instance
|
51
|
+
```
|
52
|
+
|
53
|
+
## Serializing before controller render
|
54
|
+
|
55
|
+
At times, you might want to use a serializer without rendering it to the view. For those cases, you can create an instance of `ActiveModelSerializers::SerializableResource` with
|
56
|
+
the resource you want to be serialized and call `.as_json`.
|
57
|
+
|
58
|
+
```ruby
|
59
|
+
def create
|
60
|
+
message = current_user.messages.create!(message_params)
|
61
|
+
message_json = ActiveModelSerializers::SerializableResource.new(message).as_json
|
62
|
+
MessageCreationWorker.perform(message_json)
|
63
|
+
head 204
|
64
|
+
end
|
65
|
+
```
|
@@ -0,0 +1,27 @@
|
|
1
|
+
[Back to Guides](../README.md)
|
2
|
+
|
3
|
+
# Passing Arbitrary Options To A Serializer
|
4
|
+
|
5
|
+
In addition to the [`serialization_scope`](../general/serializers.md#scope), any options passed to `render`
|
6
|
+
that are not reserved for the [adapter](../general/rendering.md#adapter_opts)
|
7
|
+
are available in the serializer as [instance_options](../general/serializers.md#instance_options).
|
8
|
+
|
9
|
+
For example, we could pass in a field, such as `user_id` into our serializer.
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
# posts_controller.rb
|
13
|
+
class PostsController < ApplicationController
|
14
|
+
def dashboard
|
15
|
+
render json: @post, user_id: 12
|
16
|
+
end
|
17
|
+
end
|
18
|
+
|
19
|
+
# post_serializer.rb
|
20
|
+
class PostSerializer < ActiveModel::Serializer
|
21
|
+
attributes :id, :title, :body
|
22
|
+
|
23
|
+
def comments_by_me
|
24
|
+
Comments.where(user_id: instance_options[:user_id], post_id: object.id)
|
25
|
+
end
|
26
|
+
end
|
27
|
+
```
|