रूबी अंगूर JSON-over-HTTP एपीआई, कस्टम JSON प्रतिनिधित्व

Question

मेरे पास Grape::API का एक छोटा प्रोटोटाइप सबक्लास है जो रैक सेवा के रूप में है, और मैं अपने एप्लिकेशन की आंतरिक ऑब्जेक्ट्स को प्रस्तुत करने के लिए Grape::Entity का उपयोग कर रहा हूं।

मुझे Grape::Entity डीएसएल पसंद है, लेकिन मुझे यह पता लगाने में परेशानी हो रही है कि मुझे डिफ़ॉल्ट JSON प्रतिनिधित्व से परे कैसे जाना चाहिए, जो हमारे उद्देश्यों के लिए बहुत हल्का है। मुझे "जेएसएंड या इसी तरह के प्रारूप" में आउटपुट तैयार करने के लिए कहा गया है: http://labs.omniti.com/labs/jsend

मुझे बिल्कुल यकीन नहीं है कि अंगूर ढांचे के साथ परिवर्तन की प्रकृति सबसे अधिक है (मुझे कम से कम पथ- प्रतिरोध यहाँ)। क्या मुझे एक कस्टम अंगूर फॉर्मेटर बनाना चाहिए (मुझे यह नहीं पता कि यह कैसे करना है), नया रैक मिडलवेयर (I ने SysLog के माध्यम से एपीआई इन्स/आउट लॉग करने के लिए ऐसा किया है - लेकिन प्रारूपण खराब लगता है क्योंकि मुझे पार्स करना होगा कंटेनर स्तर जोड़ने के लिए जेएसओएन से वापस शरीर), या Grape::Entity से दूर बदलें Rabl?

उदाहरण कोड ("app.rb")

require "grape" 
require "grape-entity" 

class Thing 
    def initialize llama_name 
    @llama_name = llama_name 
    end 
    attr_reader :llama_name 
end 

class ThingPresenter < Grape::Entity 
    expose :llama_name 
end 

class MainService < Grape::API 
    prefix  'api' 
    version  'v2' 
    format  :json 
    rescue_from :all 

    resource :thing do 
    get do 
     thing = Thing.new 'Henry' 
     present thing, :with => ThingPresenter 
    end 
    end 
end 

Rackup फाइल "(config.ru")

require File.join(File.dirname(__FILE__), "app") 
run MainService 

मैं इसे शुरू अप:

rackup -p 8090 

और कॉल यह:

curl http://127.0.0.1:8090/api/v2/thing 
{"llama_name":"Henry"} 

मैं देखना चाहते हैं क्या:

curl http://127.0.0.1:8090/api/v2/thing 
{"status":"success","data":{"llama_name":"Henry"}} 

जाहिर है मैं सिर्फ कुछ की तरह

resource :thing do 
    get do 
     thing = Thing.new 'Henry' 
     { :status => "success", :data => present(thing, :with => ThingPresenter) } 
    end 
    end 

हर मार्ग में

कर सकता है - लेकिन यह है कि बहुत शुष्क प्रतीत नहीं होता। मैं कुछ क्लीनर की तलाश में हूँ, और कम खुला & पेस्ट त्रुटियों कटौती करने के लिए जब इस एपीआई बड़ा और पूरी टीम द्वारा बनाए रखा हो जाता है

---

अजीब तरह से, जब मैं grape 0.3.2 उपयोग करने की कोशिश { :status => "success", :data => present(thing, :with => ThingPresenter) }, मैं यह काम करने के लिए नहीं मिल सका । एपीआई ने केवल present से मूल्य वापस कर दिया - शुरू में मैंने सोचा था कि यहां और भी कुछ चल रहा है।

Answer 1

यह है कि मैं क्या अंगूर प्रलेखन पढ़ने का एक संयोजन के माध्यम से, के साथ समाप्त हो गया, Googling है और github पर कुछ पुल अनुरोधों को पढ़ना। असल में, :json प्रारूप घोषित करने के बाद (इसके साथ आने वाली सभी अन्य डिफ़ॉल्ट उपहारों को प्राप्त करने के लिए), मैं आउटपुट फॉर्मेटर्स को उन लोगों के साथ सवारी करता हूं जो जेएसएंड की रैपर परत जोड़ते हैं। यह अंगूर के #present सहायक (जो त्रुटियों को अच्छी तरह से कवर नहीं करता है) को लपेटने की कोशिश करने से कोड के लिए बहुत साफ हो जाता है, या एक रैक मिडलवेयर समाधान (जिसके लिए डी-सीरियलाइजिंग और जेएसओएन को पुन: क्रमबद्ध करने की आवश्यकता होती है, साथ ही त्रुटियों को कवर करने के लिए बहुत सारे अतिरिक्त कोड लेते हैं)।

require "grape" 
require "grape-entity" 
require "json" 

module JSendSuccessFormatter 
    def self.call object, env 
    { :status => 'success', :data => object }.to_json 
    end 
end 

module JSendErrorFormatter 
    def self.call message, backtrace, options, env 
    # This uses convention that a error! with a Hash param is a jsend "fail", otherwise we present an "error" 
    if message.is_a?(Hash) 
     { :status => 'fail', :data => message }.to_json 
    else 
     { :status => 'error', :message => message }.to_json 
    end 
    end 
end 

class Thing 
    def initialize llama_name 
    @llama_name = llama_name 
    end 
    attr_reader :llama_name 
end 

class ThingPresenter < Grape::Entity 
    expose :llama_name 
end 

class MainService < Grape::API 
    prefix  'api' 
    version  'v2' 
    format  :json 
    rescue_from :all 

    formatter :json, JSendSuccessFormatter 
    error_formatter :json, JSendErrorFormatter 

    resource :thing do 
    get do 
     thing = Thing.new 'Henry' 
     present thing, :with => ThingPresenter 
    end 
    end 

    resource :borked do 
    get do 
     error! "You broke it! Yes, you!", 403 
    end 
    end 
end 

Answer 2

आप इसके लिए मिडलवेयर परत का उपयोग कर सकते हैं। अंगूर में Middleware::Base मॉड्यूल है जिसका उपयोग आप इस उद्देश्य के लिए कर सकते हैं। मेरे नहीं तो सुपर सुंदर कार्यान्वयन:

class StatusAdder < Grape::Middleware::Base 

    def initialize(app) 
    @app = app 
    end 

    def call(env) 
    status, headers, response = @app.call 
    response_hash = JSON.parse response.body.first 
    body = { :status => "success", :data => response_hash } if status == 200 

    response_string = body.to_json 
    headers['Content-Length'] = response_string.length.to_s 
    [status, headers, [response_string]] 
    end 
end 

और MainService कक्षा में, आप एक लाइन जोड़ेंगे: use ::StatusAdder

Answer 3

आज की तारीख के रूप में, मेरा मानना ​​है कि अंगूर के साथ ऐसा करने का सही तरीका है:

rescue_from Grape::Exceptions::ValidationErrors do |e| 
     response = 
     { 
      'status' => 'fail', 
      'data' => { 
       'status' => e.status, 
       'message' => e.message, 
       'errors' => e.errors 
      } 
     } 
     Rack::Response.new(response.to_json, e.status) 
    end 

Answer 4

मैं @ एक अतिरिक्त संशोधन के साथ नील-स्लेटर के समाधान का उपयोग कर रहा मैंने सोचा था कि दूसरों को उपयोगी लग सकती ।

केवल rescue_from :all के साथ आम 404 त्रुटियों के परिणाम 403 Forbidden के रूप में लौटा दिए जाते हैं। साथ ही, स्थिति 'त्रुटि' होने पर 'त्रुटि' होती है। इन समस्याओं का समाधान करने के लिए मैं RecordNotFound के लिए एक बचाव हैंडलर कहा:

rescue_from ActiveRecord::RecordNotFound do |e| 
    Rails.logger.info e.message 
    error = JSendErrorFormatter.call({message: e.message}, e.backtrace, {}, nil) 
    Rack::Response.new(error, 404, 
        { "Content-type" => "text/error" }).finish 
end 

टिप्पणी - मैं रैक env उपयोग करने के लिए उचित तरीके से समझ नहीं सका, इसलिए आप देख सकते हैं मैं इसे एक शून्य मान के रूप में में गुजर रहा (जो ठीक है क्योंकि त्रुटि हैंडलर मान का उपयोग नहीं करता है)।

मुझे लगता है कि आप प्रतिक्रिया कोड हैंडलिंग को और परिष्कृत करने के लिए इस दृष्टिकोण को आगे बढ़ा सकते हैं। मेरे लिए, मुश्किल हिस्सा यह लगा रहा था कि मुझे Rack::Response ऑब्जेक्ट की आवश्यकता है कि मैं स्वरूपित त्रुटि संदेश को पास कर सकता हूं।

Answer 5

मेरा मानना ​​है कि पूरा करता है अपने लक्ष्य का उपयोग करते समय grape

require "grape" 
require "grape-entity" 

class Thing 
    def initialize llama_name 
    @llama_name = llama_name 
    end 
    attr_reader :llama_name 
end 

class ThingPresenter < Grape::Entity 
    expose :llama_name 
end 

class MainService < Grape::API 
    prefix  'api' 
    version  'v2' 
    format  :json 
    rescue_from :all 

    resource :thing do 
    get do 
     thing = Thing.new 'Henry' 
     present :status, 'success' 
     present :data, thing, :with => ThingPresenter 
    end 
    end 
end