Building APIs on Rails 5 with AMS

A lot of people have being using Rails to develop both their internal or external API, but building a high quality API can be hard, and performance is a key point to achieve it.
I'll share my stories with APIs, and tell you how Active Model Serializer, component of Rails-API, helped me. AMS have being used across thousands of applications bringing convention over configuration to JSON generation.
This talk will give you a sneak peek of a new version of AMS that we have being working on, it's new cache conventions, and how it's being considered to be shipped by default in new Rails 5.

Transcript

1. Building APIs on Rails 5 with AMS
3. API
4. make the modern web what it is API
8. João Moura Senior engineer at Ride @joaomdmoura github/joaomdmoura
10. Building APIs on Rails 5 with AMS
19. largest city in the Americas
20. largest city in the Americas
21. largest city in the Americas the most populous city of the southern hemisphere
28. 9456 ms average time of response
31. No background job
32. Wrong Relationships No background job
33. Bad Architectures Wrong Relationships No background job
34. Bad Architectures Wrong Relationships Indexes missing No background job
35. Bad Architectures No cache at all Wrong Relationships Indexes missing No background job
36. Bad Architectures No cache at all Wrong Relationships Indexes missing No background job goo.gl/Jsw4lS
37. cat.exe stop working
38. cat.exe stop working
41. API application programming interface
42. one of the GREA TEST
43. one of the GREA TEST assets
46. one of the GREA TEST
47. one of the GREA TEST liabilities
48. An API should do one thing, and do it well. “ Joshua Blonch, Google tech talk, Jan 2007
49. Boa API
50. Boa API Performance Scalability Reusability Evolvability Documentation Easy to learn Easy to use Hard to misus
51. why Rails is the best tool
52. why Rails is the best tool it’s not
53. why Rails is the best tool it’s not but it’s a great one
55. Performance Scalability Reusability Evolvability Documentation Easy to learn Easy to use Hard to misuse
56. Performance Scalability Reusability Evolvability Documentation Easy to learn Easy to use Hard to misuse }
57. Convenções Performance Scalability Reusability Evolvability Documentation Easy to learn Easy to use Hard to misuse }
58. Convenções }
59. } Convenções }
60. }Rails Convenções }
61. Rails is robust
62. rails-api
63. rails-api Subset of a normal Rails application, created for applications that don't require all functionality of a complete Rails application
65. Rails 5
71. rails-api
72. rails-api } core ams
73. Active Model Serializer
74. AMS
75. “Bringing Convention over Configuration to your JSON” AMS
78. class PostSerializer < ActiveModel::Serializer attributes :title, :body, :comments_count def comments_count object.comments.size end end
79. class PostSerializer < ActiveModel::Serializer
80. class PostSerializer < ActiveModel::Serializer attributes :title, :body, :comments_count
81. class PostSerializer < ActiveModel::Serializer attributes :title, :body, :comments_count def comments_count object.comments.size end end
82. { id: 1, title: "ZOMG an amazing post", body: "Indeed, my friend", comments_count: 5 }
83. AMS 0.8.x
84. AMS 0.9.x
85. AMS 0.10
87. 1. Adapters Pattern
88. 1. Adapters Pattern Adapters describe how attributes and relationships should be serialized.
89. { "links": { "self": "http://example.com/posts", "next": "http://example.com/posts?page[offset]=2", "last": "http://example.com/posts?page[offset]=10" }, "data": [{ "type": "posts", "id": "1", "title": "JSON API paints my bikeshed!", "links": { "self": "http://example.com/posts/1", "author": { "self": "http://example.com/posts/1/links/author", "related": "http://example.com/posts/1/author", "linkage": { "type": "people", "id": "9" } }, "comments": { "self": "http://example.com/posts/1/links/comments", "related": "http://example.com/posts/1/comments", "linkage": [ { "type": "comments", "id": "5" }, { "type": "comments", "id": "12" } ] } } }], "included": [{ "type": "people", "id": "9", "first-name": "Dan", "last-name": "Gebhardt", "twitter": "dgeb", "links": { "self": "http://example.com/people/9" } }, { "type": "comments", "id": "5", "body": "First!", "links": { "self": "http://example.com/comments/5" } }, { "type": "comments", "id": "12", "body": "I like XML better", "links": { "self": "http://example.com/comments/12" } }] }
90. 2. JSONAPI { "links": { "self": "http://example.com/posts", "next": "http://example.com/posts?page[offset]=2", "last": "http://example.com/posts?page[offset]=10" }, "data": [{ "type": "posts", "id": "1", "title": "JSON API paints my bikeshed!", "links": { "self": "http://example.com/posts/1", "author": { "self": "http://example.com/posts/1/links/author", "related": "http://example.com/posts/1/author", "linkage": { "type": "people", "id": "9" } }, "comments": { "self": "http://example.com/posts/1/links/comments", "related": "http://example.com/posts/1/comments", "linkage": [ { "type": "comments", "id": "5" }, { "type": "comments", "id": "12" } ] } } }], "included": [{ "type": "people", "id": "9", "first-name": "Dan", "last-name": "Gebhardt", "twitter": "dgeb", "links": { "self": "http://example.com/people/9" } }, { "type": "comments", "id": "5", "body": "First!", "links": { "self": "http://example.com/comments/5" } }, { "type": "comments", "id": "12", "body": "I like XML better", "links": { "self": "http://example.com/comments/12" } }] }
91. 2. JSONAPI A standard for building APIs in JSON. { "links": { "self": "http://example.com/posts", "next": "http://example.com/posts?page[offset]=2", "last": "http://example.com/posts?page[offset]=10" }, "data": [{ "type": "posts", "id": "1", "title": "JSON API paints my bikeshed!", "links": { "self": "http://example.com/posts/1", "author": { "self": "http://example.com/posts/1/links/author", "related": "http://example.com/posts/1/author", "linkage": { "type": "people", "id": "9" } }, "comments": { "self": "http://example.com/posts/1/links/comments", "related": "http://example.com/posts/1/comments", "linkage": [ { "type": "comments", "id": "5" }, { "type": "comments", "id": "12" } ] } } }], "included": [{ "type": "people", "id": "9", "first-name": "Dan", "last-name": "Gebhardt", "twitter": "dgeb", "links": { "self": "http://example.com/people/9" } }, { "type": "comments", "id": "5", "body": "First!", "links": { "self": "http://example.com/comments/5" } }, { "type": "comments", "id": "12", "body": "I like XML better", "links": { "self": "http://example.com/comments/12" } }] }
92. 2. JSONAPI A standard for building APIs in JSON. { "links": { "self": "http://example.com/posts", "next": "http://example.com/posts?page[offset]=2", "last": "http://example.com/posts?page[offset]=10" }, "data": [{ "type": "posts", "id": "1", "title": "JSON API paints my bikeshed!", "links": { "self": "http://example.com/posts/1", "author": { "self": "http://example.com/posts/1/links/author", "related": "http://example.com/posts/1/author", "linkage": { "type": "people", "id": "9" } }, "comments": { "self": "http://example.com/posts/1/links/comments", "related": "http://example.com/posts/1/comments", "linkage": [ { "type": "comments", "id": "5" }, { "type": "comments", "id": "12" } ] } } }], "included": [{ "type": "people", "id": "9", "first-name": "Dan", "last-name": "Gebhardt", "twitter": "dgeb", "links": { "self": "http://example.com/people/9" } }, { "type": "comments", "id": "5", "body": "First!", "links": { "self": "http://example.com/comments/5" } }, { "type": "comments", "id": "12", "body": "I like XML better", "links": { "self": "http://example.com/comments/12" } }] }
93. JSONAPI 1.0
94. +
95. ActiveModel::Serializer.config.adapter = :json_api
97. 3. Cache
98. 3. Cache New implementation, optimised and following Rails conventions
99. class PostSerializer < ActiveModel::Serializer attributes :title, :body end
100. class PostSerializer < ActiveModel::Serializer cache attributes :title, :body end
101. class PostSerializer < ActiveModel::Serializer cache key: 'post' attributes :title, :body end
102. class PostSerializer < ActiveModel::Serializer cache key: 'post', expires_in: 3.hours attributes :title, :body end
103. class PostsController < ApplicationController def index @posts = Post.all render json: @posts end end
104. class PostsController < ApplicationController def index @posts = Post.all render json: @posts end end
105. class PostsController < ApplicationController def index @posts = Post.all render json: @posts end def show @post = Post.find(params[:id]) render json: @post end end
107. 4. Fragment Cache
108. 4. Fragment Cache Rails conventions to cache specific attributes
109. class PostSerializer < ActiveModel::Serializer attributes :title, :body, :comments_count def title "Post - #{object.title}" end def comments_count object.comments.size end end
110. def title "Post - #{object.title}" end def comments_count object.comments.size end
111. def title "Post - #{object.title}" end def comments_count object.comments.size end cacheable
112. def title "Post - #{object.title}" end def comments_count object.comments.size end cacheable non-cacheable
113. class PostSerializer < ActiveModel::Serializer attributes :title, :body, :comments_count def title "Post - #{object.title}" end def comments_count object.comments.size end end
114. class PostSerializer < ActiveModel::Serializer cache only: [:title] attributes :title, :body, :comments_count def title "Post - #{object.title}" end def comments_count object.comments.size end end
115. class PostSerializer < ActiveModel::Serializer cache except: [:comments_count] attributes :title, :body, :comments_count def title "Post - #{object.title}" end def comments_count object.comments.size end end
116. class PostSerializer < ActiveModel::Serializer cache key: 'post', expires_in: 3.hours, only: [:title] attributes :title, :body end
117. In God we trust… All the others bring data
118. 0.9.x 42.680000 user system total real 17.630000 60.310000 71.201321
119. 0.9.x 0.10.0 real 71.201321 63.926189
120. 0.9.x 0.10.0 real 71.201321 57.851192
122. freaking amazing features
124. Deserialization Output equals the input
125. @post = Post.create(post_params) render json: @post, statue: :created end def post_params PostSerialization.deserialize(params) end
126. def create @post = Post.create(post_params) render json: @post, status: :created end def post_params PostSerialization.deserialize(params) end
128. Documentação Gift!
130. fetch multi pagination e more!
132. AMS 0.10.0
133. AMS 0.10.0
134. AMS 0.10.0
136. 0.10.0 rc3
138. one more thing
139. Thank you!
140. Thank you!
141. Thank you!
143. AMS 0.10
144. Adapter Pattern
145. Json API
146. Cache
147. Fragment Cache
148. Rails 5
152. ElixirbyaRubyist.com #ElixirbyaRubyist
153. @joaomdmoura ElixirbyaRubyist.com