Ruby API response view : how can I render a JSON response?

Question

I'm new to Ruby, trying to building an API.

I've followed a tutorial and was able to return a JSON response when calling an API endpoint.

In this example, the function called raises an error that I want to pass as a JSON response.

my_controller.rb

class MyController < ApplicationController
  def getTracklist

    begin
      importer = #this raises an error
    rescue StandardError => e
      @response = {
      error:  e.message,
      }
      return @response
    end

  end

end

my view look like this :

getTracklist.json.jbuilder

json.response @response

thing is,

this works but renders my response as

{"response":{"error":"the error message"}}

while I want it as

{"error":"the error message"}

I made an attempts by changing my view to

json @response

but it fails :

ActionView::Template::Error (undefined method `json' for <#:0x0000559304675470> Did you mean? JSON): 1: json @response

So how could I render my response "fully" without having to put it in a property ?

I've also seen when reading stuff about ROR that this code is sometimes used, and I was wondering how I could use it in this situation :

render json: { error_code:'not_found', error: e.message }, status: :not_found

Thanks !

3limin4t0r · Accepted Answer · 2020-03-05 10:20:00Z

1

There are multiple ways of achieving what you want. You could merge! the response into the jbuilder root.

json.merge! @response

The above merges all key/value-pairs into the jbuilder root. You could also opt to extract! specific attributes.

json.extract! @response, :error

Alternatively you can simply render it in the controller, since you've already composed the structure the following would be enough.

render json: @response

answered Mar 5, 2020 at 10:20

3limin4t0r

21.4k3 gold badges38 silver badges61 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

gordie Over a year ago

most complete response even if the others were right. Thanks, no view = better !

Rifatul Islam Chayon · Accepted Answer · 2020-03-05 09:57:02Z

0

You can do this for jBuilder:

json.merge!(@response)

Source

answered Mar 5, 2020 at 9:57

Rifatul Islam Chayon

4624 silver badges7 bronze badges

Comments

Full Stack Dev · Accepted Answer · 2020-03-05 10:03:21Z

0

class MyController < ApplicationController
  def getTracklist

    begin
     # you need to assign something to a variable
    rescue StandardError => e
      respond_to do |format|
        format.any(:json, :js) do
          render :json => {:error => e.message}
        end
      end
    end
  end
end

Making these changes to your controller can help you with your requirements. You don't need a view after doing this.

answered Mar 5, 2020 at 10:03

Full Stack Dev

845 bronze badges

Collectives™ on Stack Overflow

Ruby API response view : how can I render a JSON response?

my_controller.rb

getTracklist.json.jbuilder

thing is,

3 Answers 3

1 Comment

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

my_controller.rb

getTracklist.json.jbuilder

thing is,

3 Answers 3

1 Comment

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related