Response

Let’s say you have some JSON payload which is constructed using Panko serialization result, like this:

class PostsController < ApplicationController
  def index
   posts = Post.all
   render json: {
     success: true,
     total_count: posts.count,
     posts: Panko::ArraySerializer.new(posts, each_serializer: PostSerializer).to_json
   }
  end
end

The output of the above will be a JSON string (for posts) inside a JSON string and this were Panko::Response shines.

class PostsController < ApplicationController
  def index
   posts = Post.all
   render json: Panko::Response.new(
     success: true,
     total_count: posts.count,
     posts: Panko::ArraySerializer.new(posts, each_serializer: PostSerializer)
   )
  end
end

And everything will work as expected!

For a single object serialization, we need to use a different API (since Panko::Serializer doesn’t accept an object in it’s constructor):

class PostsController < ApplicationController
  def show
    post = Post.find(params[:id])

    render(
      json: Panko::Response.create do |r|
        {
          success: true,
          post: r.serializer(post, PostSerializer)
        }
      end
    )
  end
end

JsonValue

Let’s take the above example further, we will serialize the posts and cache it as JSON string in our Cache. Now, you can wrap the cached value with Panko::JsonValue, like here:

class PostsController < ApplicationController
  def index
   posts = Cache.get("/posts")

   render json: Panko::Response.new(
     success: true,
     total_count: posts.count,
     posts: Panko::JsonValue.from(posts)
   )
  end
end