grape
1.0.0
Traube ist ein ruhiger API-Framework für Ruby. Es wurde entwickelt, um vorhandene Webanwendungs -Frameworks wie Rails und Sinatra zu erfüllen oder eine einfache DSL zu ermöglichen, um leicht erholsame APIs zu entwickeln. Es wird ein integrierter Unterstützung für gemeinsame Konventionen, einschließlich mehrerer Formate, Subdomain-/Präfix-Einschränkungen, Inhaltsverhandlung, Versioning und vielem mehr.
Sie lesen die Dokumentation für die nächste Veröffentlichung von Grape, die 2.3.0 sein sollte. Die aktuelle stabile Version ist 2.2.0.
Erhältlich als Teil des Tidelift -Abonnements.
Die Pfleger der Traube arbeiten mit Tidelift, um kommerzielle Unterstützung und Wartung zu liefern. Sparen Sie Zeit, reduzieren Sie das Risiko und verbessern Sie die Gesundheit des Codes, während Sie die Wartungsbetreuer zahlen. Klicken Sie hier, um weitere Informationen zu erhalten.
Ruby 2.7 oder neuer ist erforderlich.
Traube ist als Juwel erhältlich, um es zu installieren:
bundle add grape
Trauben -APIs sind Rack -Anwendungen, die durch Subklassen Grape::API erstellt werden. Im Folgenden finden Sie ein einfaches Beispiel, das einige der häufigsten Merkmale von Trauben im Kontext der Wiederherstellung von Teilen der Twitter -API zeigt.
module Twitter
class API < Grape :: API
version 'v1' , using : :header , vendor : 'twitter'
format :json
prefix :api
helpers do
def current_user
@current_user ||= User . authorize! ( env )
end
def authenticate!
error! ( '401 Unauthorized' , 401 ) unless current_user
end
end
resource :statuses do
desc 'Return a public timeline.'
get :public_timeline do
Status . limit ( 20 )
end
desc 'Return a personal timeline.'
get :home_timeline do
authenticate!
current_user . statuses . limit ( 20 )
end
desc 'Return a status.'
params do
requires :id , type : Integer , desc : 'Status ID.'
end
route_param :id do
get do
Status . find ( params [ :id ] )
end
end
desc 'Create a status.'
params do
requires :status , type : String , desc : 'Your status.'
end
post do
authenticate!
Status . create! ( {
user : current_user ,
text : params [ :status ]
} )
end
desc 'Update a status.'
params do
requires :id , type : String , desc : 'Status ID.'
requires :status , type : String , desc : 'Your status.'
end
put ':id' do
authenticate!
current_user . statuses . find ( params [ :id ] ) . update ( {
user : current_user ,
text : params [ :status ]
} )
end
desc 'Delete a status.'
params do
requires :id , type : String , desc : 'Status ID.'
end
delete ':id' do
authenticate!
current_user . statuses . find ( params [ :id ] ) . destroy
end
end
end
end Der Abschrekator der Grape wird den Abschreibungen Ihrer Anwendung automatisch als :grape hinzugefügt, sodass die Konfiguration Ihrer Anwendung darauf angewendet werden kann.
Standardmäßig werden die Routen auf der ersten Route kompiliert. Es ist möglich, Routen mit dem compile! Verfahren.
Twitter :: API . compile! Dies kann zu Ihrer config.ru (falls RackUp), application.rb (bei Verwendung von Schienen) oder einer Datei hinzugefügt werden, die Ihren Server lädt.
Das obige Beispiel erstellt eine Rack -Anwendung, die mit rackup aus einer Rackup config.ru ausgeführt werden kann:
run Twitter :: API(Mit der Vorladung können Sie verwenden)
Twitter :: API . compile!
run Twitter :: APIUnd würde auf die folgenden Routen reagieren:
GET /api/statuses/public_timeline
GET /api/statuses/home_timeline
GET /api/statuses/:id
POST /api/statuses
PUT /api/statuses/:id
DELETE /api/statuses/:id
Traube reagiert auch automatisch auf Kopf und Optionen für alle Get und nur Optionen für alle anderen Routen.
Wenn Sie die Traube neben einem anderen Rack -Framework wie Sinatra montieren möchten, können Sie dies einfach mit Rack::Cascade tun:
# Example config.ru
require 'sinatra'
require 'grape'
class API < Grape :: API
get :hello do
{ hello : 'world' }
end
end
class Web < Sinatra :: Base
get '/' do
'Hello world.'
end
end
use Rack :: Session :: Cookie
run Rack :: Cascade . new [ Web , API ] Beachten Sie, dass die Reihenfolge des Ladens von Apps mit Rack::Cascade Matters. Die Traubenanwendung muss zuletzt sein, wenn Sie kundenspezifische 404 Fehler aus der Traube aufnehmen möchten (z. B. error!('Not Found',404) ). Wenn die Traubenanwendung nicht dauert und die Antwort von 404 oder 405 zurückgibt, verwendet Cascade dies als Signal, um die nächste App auszuprobieren. Dies kann zu unerwünschtem Verhalten führen, das die falsche 404 -Seite aus der falschen App zeigt.
Platzieren Sie API -Dateien in app/api . Rails erwartet ein Unterverzeichnis, das dem Namen des Ruby -Moduls entspricht, und einen Dateinamen, der dem Namen der Klasse entspricht. In unserem Beispiel sollte der Dateinamen und das Verzeichnis für Twitter::API app/api/twitter/api.rb sein.
Ändern Sie config/routes :
mount Twitter :: API => '/' Die Standard -Autoloader von Rails ist Zeitwerk . Standardmäßig enthält es api als Api anstelle von API . Um unser Beispiel zum Laufen zu bringen, müssen Sie die Linien am Ende der config/initializers/inflections.rb inkämpft und API als Akronym hinzufügen:
ActiveSupport :: Inflector . inflections ( :en ) do | inflect |
inflect . acronym 'API'
endSie können mehrere API -Implementierungen innerhalb eines anderen montieren. Dies müssen keine unterschiedlichen Versionen sein, sondern möglicherweise Komponenten derselben API.
class Twitter :: API < Grape :: API
mount Twitter :: APIv1
mount Twitter :: APIv2
end Sie können auch auf einem Pfad montieren, der der Verwendung prefix innerhalb der montierten API selbst ähnlich ist.
class Twitter :: API < Grape :: API
mount Twitter :: APIv1 => '/v1'
end Deklarationen wie before/after/rescue_from können vor oder nach mount platziert werden. In jedem Fall werden sie geerbt.
class Twitter :: API < Grape :: API
before do
header 'X-Base-Header' , 'will be defined for all APIs that are mounted below'
end
rescue_from :all do
error! ( { "error" => "Internal Server Error" } , 500 )
end
mount Twitter :: Users
mount Twitter :: Search
after do
clean_cache!
end
rescue_from ZeroDivisionError do
error! ( { "error" => "Not found" } , 404 )
end
end Sie können die gleichen Endpunkte an zwei verschiedenen Stellen montieren.
class Voting :: API < Grape :: API
namespace 'votes' do
get do
# Your logic
end
post do
# Your logic
end
end
end
class Post :: API < Grape :: API
mount Voting :: API
end
class Comment :: API < Grape :: API
mount Voting :: API
end Unter der Annahme, dass die Post- und Kommentarendpunkte in /posts und /comments montiert sind, sollten Sie jetzt in der Lage sein, get /posts/votes , post /posts/votes , get /comments/votes und post /comments/votes .
Sie können wiederholbare Endpunkte konfigurieren, um die Art und Weise zu ändern, wie sie sich verhalten, wo sie montiert sind.
class Voting :: API < Grape :: API
namespace 'votes' do
desc "Vote for your #{ configuration [ :votable ] } "
get do
# Your logic
end
end
end
class Post :: API < Grape :: API
mount Voting :: API , with : { votable : 'posts' }
end
class Comment :: API < Grape :: API
mount Voting :: API , with : { votable : 'comments' }
end Beachten Sie, dass Sie, wenn Sie einen Hash als erster Parameter zum mount übergeben, explizit () um Parameter einstellen müssen:
# good
mount ( { :: Some :: Api => '/some/api' } , with : { condition : true } )
# bad
mount :: Some :: Api => '/some/api' , with : { condition : true } Sie können in der Klasse auf configuration zugreifen (um sie als dynamische Attribute zu verwenden) in Blöcken (wie Namespace)
Wenn Sie in einer configuration eine Logik erfolgen möchten, können Sie den given Helfer verwenden.
class ConditionalEndpoint :: API < Grape :: API
given configuration [ :some_setting ] do
get 'mount_this_endpoint_conditionally' do
configuration [ :configurable_response ]
end
end
end Wenn Sie ein Logikblock jedes Mal ausgeführt werden möchten, wenn ein Endpunkt montiert ist (innerhalb dessen Sie auf den configuration -Hash zugreifen können)
class ConditionalEndpoint :: API < Grape :: API
mounted do
YourLogger . info "This API was mounted at: #{ Time . now } "
get configuration [ :endpoint_name ] do
configuration [ :configurable_response ]
end
end
end Komplexere Ergebnisse können erzielt werden mounted indem die configuration bereits als Hash bewertet wird.
class ExpressionEndpointAPI < Grape :: API
get ( mounted { configuration [ :route_name ] || 'default_name' } ) do
# some logic
end
end class BasicAPI < Grape :: API
desc 'Statuses index' do
params : ( configuration [ :entity ] || API :: Entities :: Status ) . documentation
end
params do
requires :all , using : ( configuration [ :entity ] || API :: Entities :: Status ) . documentation
end
get '/statuses' do
statuses = Status . all
type = current_user . admin? ? :full : :default
present statuses , with : ( configuration [ :entity ] || API :: Entities :: Status ) , type : type
end
end
class V1 < Grape :: API
version 'v1'
mount BasicAPI , with : { entity : mounted { configuration [ :entity ] || API :: Entities :: Status } }
end
class V2 < Grape :: API
version 'v2'
mount BasicAPI , with : { entity : mounted { configuration [ :entity ] || API :: Entities :: V2 :: Status } }
end Sie haben die Möglichkeit, verschiedene Versionen Ihrer API bereitzustellen, indem Sie für jede angebotene Version eine separate Grape::API -Klasse erstellen und dann in eine primäre Grape::API -Klasse. Stellen Sie sicher, dass neuere Versionen vor älteren montiert sind. Der Standardansatz für die Versionierung leitet die Anforderung an die nachfolgende Rack Middleware an, wenn keine bestimmte Version gefunden wird.
require 'v1'
require 'v2'
require 'v3'
class App < Grape :: API
mount V3
mount V2
mount V1
endUm dieselben Endpunkte aus früheren API -Versionen beizubehalten, ohne sie neu zu schreiben, können Sie mehrere Versionen innerhalb der vorherigen API -Versionen angeben.
class V1 < Grape :: API
version 'v1' , 'v2' , 'v3'
get '/foo' do
# your code for GET /foo
end
get '/other' do
# your code for GET /other
end
end
class V2 < Grape :: API
version 'v2' , 'v3'
get '/var' do
# your code for GET /var
end
end
class V3 < Grape :: API
version 'v3'
get '/foo' do
# your new code for GET /foo
end
endUnter Verwendung des angegebenen Beispiels sind die nachfolgenden Endpunkte über verschiedene Versionen hinweg zugegriffen:
GET /v1/foo
GET /v1/other
GET /v2/foo # => Same behavior as v1
GET /v2/other # => Same behavior as v1
GET /v2/var # => New endpoint not available in v1
GET /v3/foo # => Different behavior to v1 and v2
GET /v3/other # => Same behavior as v1 and v2
GET /v3/var # => Same behavior as v2 Es gibt vier Strategien, in denen Kunden die Endpunkte Ihrer API erreichen können :: :path ,: :header ,: :accept_version_header UND :param . Die Standardstrategie ist :path .
version 'v1' , using : :pathMit dieser Versionungsstrategie sollten Kunden die gewünschte Version in der URL übergeben.
curl http://localhost:9292/v1/statuses/public_timeline
version 'v1' , using : :header , vendor : 'twitter'Derzeit unterstützt GREPE nur versionierte Medientypen im folgenden Format:
vnd.vendor-and-or-resource-v1234+format
Grundsätzlich werden alle Token zwischen dem Finale - und dem + als Version interpretiert.
Mit dieser Versionungsstrategie sollten Kunden die gewünschte Version im HTTP Accept Head übergeben.
curl -H Accept:application/vnd.twitter-v1+json http://localhost:9292/statuses/public_timeline
Standardmäßig wird die erste übereinstimmende Version verwendet, wenn kein Accept -Header geliefert wird. Dieses Verhalten ähnelt dem Routing in Schienen. Um dieses Standardverhalten zu umgehen, kann man die :strict Option verwenden. Wenn diese Option auf true eingestellt ist, wird ein 406 Not Acceptable Fehler zurückgegeben, wenn kein korrekter Accept geliefert wird.
Wenn ein ungültiger Accept geliefert wird, wird ein 406 Not Acceptable Fehler zurückgegeben, wenn die Option :cascade auf false eingestellt ist. Andernfalls wird ein 404 Not Found Fehler von Rack zurückgegeben, wenn keine andere Route übereinstimmt.
Die Traube bewertet die relativen Qualitätspräferenz, die in Akzeptieren von Header enthalten sind, und stand bei der Auslassung von 1,0. Im folgenden Beispiel wird eine Trauben -API, die XML und JSON in dieser Reihenfolge unterstützt, JSON zurückgeben:
curl -H "Accept: text/xml;q=0.8, application/json;q=0.9" localhost:1234/resource
version 'v1' , using : :accept_version_header Mit dieser Versionungsstrategie sollten Kunden die gewünschte Version im HTTP- Accept-Version Header übergeben.
curl -H "Accept-Version:v1" http://localhost:9292/statuses/public_timeline
Standardmäßig wird die erste passende Version verwendet, wenn kein Accept-Version Header geliefert wird. Dieses Verhalten ähnelt dem Routing in Schienen. Um dieses Standardverhalten zu umgehen, kann man die :strict Option verwenden. Wenn diese Option auf true eingestellt ist, wird ein 406 Not Acceptable Fehler zurückgegeben, wenn kein korrekter Accept geliefert wird und die :cascade -Option auf false eingestellt ist. Andernfalls wird ein 404 Not Found Fehler von Rack zurückgegeben, wenn keine andere Route übereinstimmt.
version 'v1' , using : :paramMit dieser Versionungsstrategie sollten Clients die gewünschte Version als Anforderungsparameter entweder in der URL -Abfrage -Zeichenfolge oder in der Anforderungsbehörde übergeben.
curl http://localhost:9292/statuses/public_timeline?apiver=v1
Der Standardname für den Parameter Abfrage ist 'apiver' kann jedoch mit der Option :parameter angegeben werden.
version 'v1' , using : :param , parameter : 'v' curl http://localhost:9292/statuses/public_timeline?v=v1
Sie können den API -Methoden und -Namespaces eine Beschreibung hinzufügen. Die Beschreibung würde von Traubenschack verwendet, um Spristing-konforme Dokumentation zu generieren.
HINWEIS: BESCHREIBUNG BLOCK ist nur für die Dokumentation dient und wirkt sich nicht auf das API -Verhalten aus.
desc 'Returns your public timeline.' do
summary 'summary'
detail 'more details'
params API :: Entities :: Status . documentation
success API :: Entities :: Entity
failure [ [ 401 , 'Unauthorized' , 'Entities::Error' ] ]
default { code : 500 , message : 'InvalidRequest' , model : Entities :: Error }
named 'My named route'
headers XAuthToken : {
description : 'Validates your identity' ,
required : true
} ,
XOptionalHeader : {
description : 'Not really needed' ,
required : false
}
hidden false
deprecated false
is_array true
nickname 'nickname'
produces [ 'application/json' ]
consumes [ 'application/json' ]
tags [ 'tag1' , 'tag2' ]
end
get :public_timeline do
Status . limit ( 20 )
enddetail : Eine verbesserte Beschreibungparams : Parameter direkt aus einer Entity definierensuccess : (frühere Entität) Das Entity , das verwendet wird, um die Erfolgsreaktion für diesen Weg zu präsentieren.failure : (Ehemalige http_codes) Eine Definition des verwendeten Fehlers HTTP -Codes und -Entitäten.default : Die Definition und Entity die verwendet wird, um die Standardantwort für diese Route darzustellen.namedheaders : Eine Definition der verwendeten Headers Verwenden Sie Grape.configure , um die globalen Einstellungen zur Ladezeit einzurichten. Derzeit sind die konfigurierbaren Einstellungen:
param_builder : Legt den Parameter Builder fest, standardmäßig auf Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder .Um einen Einstellwert zu ändern, stellen Sie sicher, dass der folgende Code irgendwann während der Ladezeit ausgeführt wird
Grape . configure do | config |
config . setting = value
end Zum Beispiel kann für den param_builder der folgende Code in einem Initialisierer ausgeführt werden:
Grape . configure do | config |
config . param_builder = Grape :: Extensions :: Hashie :: Mash :: ParamBuilder
endSie können auch eine einzelne API konfigurieren:
API . configure do | config |
config [ key ] = value
end Dies wird in der API mit configuration verfügbar sein, als ob es sich um eine Mount -Konfiguration handelt.
Anforderungsparameter sind über das params Hash -Objekt verfügbar. Dazu gehören Parameter GET , POST und PUT sowie alle benannten Parameter, die Sie in Ihren Routenzeichenfolgen angeben.
get :public_timeline do
Status . order ( params [ :sort_by ] )
end Die Parameter werden automatisch aus dem Anforderungskörper auf POST gefüllt und für Formulareingabe-, JSON- und XML-Inhaltstypen PUT .
Die Anfrage:
curl -d '{"text": "140 characters"}' 'http://localhost:9292/statuses' -H Content-Type:application/json -v
Der Traubenendpunkt:
post '/statuses' do
Status . create! ( text : params [ :text ] )
endMehrviertel Posts und Puts werden ebenfalls unterstützt.
Die Anfrage:
curl --form image_file='@image.jpg;type=image/jpg' http://localhost:9292/upload
Der Traubenendpunkt:
post 'upload' do
# file in params[:image_file]
endIm Falle eines Konflikts zwischen einem von:
GET , POST und PUTPOST und PUTDie Routenzeichenfolgenparameter haben Vorrang.
Standardmäßig sind Parameter als ActiveSupport::HashWithIndifferentAccess verfügbar. Dies kann beispielsweise in Ruby Hash oder Hashie::Mash für die gesamte API geändert werden.
class API < Grape :: API
include Grape :: Extensions :: Hashie :: Mash :: ParamBuilder
params do
optional :color , type : String
end
get do
params . color # instead of params[:color]
end Die Klasse kann auch in einzelnen Parameterblöcken unter Verwendung von build_with wie folgt überschrieben werden.
params do
build_with Grape :: Extensions :: Hash :: ParamBuilder
optional :color , type : String
end Oder weltweit mit der Konfiguration Grape.configure.param_builder .
Im obigen Beispiel werden params["color"] nil zurückgeben, da params ein einfacher Hash sind.
Verfügbare Parameterbauer sind Grape::Extensions::Hash::ParamBuilder , Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder und Grape::Extensions::Hashie::Mash::ParamBuilder .
Mit Trauben können Sie nur auf die Parameter zugreifen, die durch Ihren params deklariert wurden. Es wird:
Betrachten Sie den folgenden API -Endpunkt:
format :json
post 'users/signup' do
{ 'declared_params' => declared ( params ) }
end Wenn Sie keine Parameter angeben, gibt declared einen leeren Hash zurück.
Anfrage
curl -X POST -H " Content-Type: application/json " localhost:9292/users/signup -d ' {"user": {"first_name":"first name", "last_name": "last name"}} 'Antwort
{
"declared_params" : {}
}
Sobald wir Parameteranforderungen hinzufügen, wird Traube nur die deklarierten Parameter zurückgeben.
format :json
params do
optional :user , type : Hash do
optional :first_name , type : String
optional :last_name , type : String
end
end
post 'users/signup' do
{ 'declared_params' => declared ( params ) }
endAnfrage
curl -X POST -H " Content-Type: application/json " localhost:9292/users/signup -d ' {"user": {"first_name":"first name", "last_name": "last name", "random": "never shown"}} 'Antwort
{
"declared_params" : {
"user" : {
"first_name" : " first name " ,
"last_name" : " last name "
}
}
} Fehlende Parameter, die als Typ Hash oder Array deklariert werden, werden enthalten.
format :json
params do
optional :user , type : Hash do
optional :first_name , type : String
optional :last_name , type : String
end
optional :widgets , type : Array
end
post 'users/signup' do
{ 'declared_params' => declared ( params ) }
endAnfrage
curl -X POST -H " Content-Type: application/json " localhost:9292/users/signup -d ' {} 'Antwort
{
"declared_params" : {
"user" : {
"first_name" : null ,
"last_name" : null
},
"widgets" : []
}
} Der zurückgegebene Hash ist ein ActiveSupport::HashWithIndifferentAccess .
Die #declared -Methode ist before Filtern nicht verfügbar, da diese vor dem Parameterzwang bewertet werden.
Standardmäßig declared(params) enthält Parameter, die in allen übergeordneten Namespaces definiert wurden. Wenn Sie nur Parameter aus Ihrem aktuellen Namespace zurückgeben möchten, können Sie die Option include_parent_namespaces auf false festlegen.
format :json
namespace :parent do
params do
requires :parent_name , type : String
end
namespace ':parent_name' do
params do
requires :child_name , type : String
end
get ':child_name' do
{
'without_parent_namespaces' => declared ( params , include_parent_namespaces : false ) ,
'with_parent_namespaces' => declared ( params , include_parent_namespaces : true ) ,
}
end
end
endAnfrage
curl -X GET -H " Content-Type: application/json " localhost:9292/parent/foo/barAntwort
{
"without_parent_namespaces" : {
"child_name" : " bar "
},
"with_parent_namespaces" : {
"parent_name" : " foo " ,
"child_name" : " bar "
},
} Standardmäßig declared(params) enthält Parameter mit nil -Werten. Wenn Sie nur die Parameter zurückgeben möchten, die nicht nil sind, können Sie die Option include_missing verwenden. Standardmäßig ist include_missing auf true festgelegt. Betrachten Sie die folgende API:
format :json
params do
requires :user , type : Hash do
requires :first_name , type : String
optional :last_name , type : String
end
end
post 'users/signup' do
{ 'declared_params' => declared ( params , include_missing : false ) }
endAnfrage
curl -X POST -H " Content-Type: application/json " localhost:9292/users/signup -d ' {"user": {"first_name":"first name", "random": "never shown"}} 'Antwort mit Include_miss: Falsch
{
"declared_params" : {
"user" : {
"first_name" : " first name "
}
}
}Antwort mit Include_miss: True
{
"declared_params" : {
"user" : {
"first_name" : " first name " ,
"last_name" : null
}
}
}Es funktioniert auch auf verschachtelten Hashes:
format :json
params do
requires :user , type : Hash do
requires :first_name , type : String
optional :last_name , type : String
requires :address , type : Hash do
requires :city , type : String
optional :region , type : String
end
end
end
post 'users/signup' do
{ 'declared_params' => declared ( params , include_missing : false ) }
endAnfrage
curl -X POST -H " Content-Type: application/json " localhost:9292/users/signup -d ' {"user": {"first_name":"first name", "random": "never shown", "address": { "city": "SF"}}} 'Antwort mit Include_miss: Falsch
{
"declared_params" : {
"user" : {
"first_name" : " first name " ,
"address" : {
"city" : " SF "
}
}
}
}Antwort mit Include_miss: True
{
"declared_params" : {
"user" : {
"first_name" : " first name " ,
"last_name" : null ,
"address" : {
"city" : " Zurich " ,
"region" : null
}
}
}
} Beachten Sie, dass ein Attribut mit einem nil -Wert nicht als fehlend angesehen wird und auch zurückgegeben wird, wenn include_missing auf false festgelegt wird:
Anfrage
curl -X POST -H " Content-Type: application/json " localhost:9292/users/signup -d ' {"user": {"first_name":"first name", "last_name": null, "address": { "city": "SF"}}} 'Antwort mit Include_miss: Falsch
{
"declared_params" : {
"user" : {
"first_name" : " first name " ,
"last_name" : null ,
"address" : { "city" : " SF " }
}
}
} Standardmäßig declared(params) werden nicht alle Parameter given und zurückgeben. Verwenden Sie evaluate_given , um alle given Blöcke zu bewerten und nur Parameter zurückzugeben, die given Bedingungen erfüllen. Betrachten Sie die folgende API:
format :json
params do
optional :child_id , type : Integer
given :child_id do
requires :father_id , type : Integer
end
end
post 'child' do
{ 'declared_params' => declared ( params , evaluate_given : true ) }
endAnfrage
curl -X POST -H " Content-Type: application/json " localhost:9292/child -d ' {"father_id": 1} 'Antwort mit evaluate_given: false
{
"declared_params" : {
"child_id" : null ,
"father_id" : 1
}
}Antwort mit evaluate_given: true
{
"declared_params" : {
"child_id" : null
}
}Es funktioniert auch auf verschachtelten Hashes:
format :json
params do
requires :child , type : Hash do
optional :child_id , type : Integer
given :child_id do
requires :father_id , type : Integer
end
end
end
post 'child' do
{ 'declared_params' => declared ( params , evaluate_given : true ) }
endAnfrage
curl -X POST -H " Content-Type: application/json " localhost:9292/child -d ' {"child": {"father_id": 1}} 'Antwort mit evaluate_given: false
{
"declared_params" : {
"child" : {
"child_id" : null ,
"father_id" : 1
}
}
}Antwort mit evaluate_given: true
{
"declared_params" : {
"child" : {
"child_id" : null
}
}
} Die Verwendung route_param hat höhere Vorrang vor einem regulären Parameter, der mit demselben Namen definiert ist:
params do
requires :foo , type : String
end
route_param :foo do
get do
{ value : params [ :foo ] }
end
endAnfrage
curl -X POST -H " Content-Type: application/json " localhost:9292/bar -d ' {"foo": "baz"} 'Antwort
{
"value" : " bar "
} Sie können Validierungen und Zwangoptionen für Ihre Parameter mithilfe eines params definieren.
params do
requires :id , type : Integer
optional :text , type : String , regexp : / A [a-z]+ z /
group :media , type : Hash do
requires :url
end
optional :audio , type : Hash do
requires :format , type : Symbol , values : [ :mp3 , :wav , :aac , :ogg ] , default : :mp3
end
mutually_exclusive :media , :audio
end
put ':id' do
# params[:id] is an Integer
endWenn ein Typ angegeben wird, erfolgt nach dem Zwang eine implizite Validierung, um sicherzustellen, dass der Ausgangstyp derjenige ist, der deklariert ist.
Optionale Parameter können einen Standardwert haben.
params do
optional :color , type : String , default : 'blue'
optional :random_number , type : Integer , default : -> { Random . rand ( 1 .. 100 ) }
optional :non_random_number , type : Integer , default : Random . rand ( 1 .. 100 )
end Standardwerte werden eifrig bewertet. Oben :non_random_number wird für jeden Aufruf zum Endpunkt dieses params auf dieselbe Nummer bewertet. Um die Standardeinstellung bei jeder Anfrage faul zu bewerten, verwenden Sie eine Lambda wie :random_number oben.
Beachten Sie, dass Standardwerte an alle angegebenen Validierungsoptionen weitergegeben werden. Das folgende Beispiel fällt immer fehl, wenn :color nicht explizit bereitgestellt wird.
params do
optional :color , type : String , default : 'blue' , values : [ 'red' , 'green' ]
endDie korrekte Implementierung besteht darin, sicherzustellen, dass der Standardwert alle Validierungen übergeht.
params do
optional :color , type : String , default : 'blue' , values : [ 'blue' , 'red' , 'green' ]
end Sie können den Wert eines Parameters als Standardwert eines anderen Parameters verwenden. In diesem Fall hat der Parameter primary_color nicht den gleichen Wert wie die color . Wenn beide nicht bereitgestellt werden, haben beide blue Wert.
params do
optional :color , type : String , default : 'blue'
optional :primary_color , type : String , default : -> ( params ) { params [ :color ] }
endIm Folgenden sind alle gültigen Typen aufgeführt, die von Grape aus dem Box unterstützt werden:
File )Bitte beachten Sie, dass sich das Verhalten zwischen Ruby 2.4 und früheren Versionen unterscheidet. In Ruby 2.4 werden Werte, die aus Zahlen bestehen, in Ganzzahl umgewandelt, aber in früheren Versionen werden sie als Fixnum behandelt.
params do
requires :integers , type : Hash do
requires :int , coerce : Integer
end
end
get '/int' do
params [ :integers ] [ :int ] . class
end
. ..
get '/int' integers : { int : '45' }
#=> Integer in ruby 2.4
#=> Fixnum in earlier ruby versions Abgesehen von dem Standardsatz der oben aufgeführten unterstützten Typen kann jede Klasse als Typ verwendet werden, solange eine explizite Zwangsmethode geliefert wird. Wenn der Typ eine parse -Methode auf Klassenebene implementiert, wird sie automatisch verwendet. Diese Methode muss ein String -Argument annehmen und eine Instanz des richtigen Typs zurückgeben oder eine Instanz von Grape::Types::InvalidValue zurückgeben, die optional eine Nachricht akzeptiert, die in der Antwort zurückgegeben werden soll.
class Color
attr_reader :value
def initialize ( color )
@value = color
end
def self . parse ( value )
return new ( value ) if %w[ blue red green ] . include? ( value )
Grape :: Types :: InvalidValue . new ( 'Unsupported color' )
end
end
params do
requires :color , type : Color , default : Color . new ( 'blue' )
requires :more_colors , type : Array [ Color ] # Collections work
optional :unique_colors , type : Set [ Color ] # Duplicates discarded
end
get '/stuff' do
# params[:color] is already a Color.
params [ :color ] . value
end Alternativ kann eine benutzerdefinierte Zwangsmethode für jede Art von Parameter unter Verwendung von coerce_with geliefert werden. Es kann eine Klasse oder ein Objekt angegeben werden, die eine parse oder call in dieser Reihenfolge der Vorrang implementieren. Die Methode muss einen einzelnen String -Parameter akzeptieren und der Rückgabewert muss mit dem angegebenen type übereinstimmen.
params do
requires :passwd , type : String , coerce_with : Base64 . method ( :decode64 )
requires :loud_color , type : Color , coerce_with : -> ( c ) { Color . parse ( c . downcase ) }
requires :obj , type : Hash , coerce_with : JSON do
requires :words , type : Array [ String ] , coerce_with : -> ( val ) { val . split ( / s +/ ) }
optional :time , type : Time , coerce_with : Chronic
end
end Beachten Sie, dass ein nil -Wert die benutzerdefinierte Zwangsmethode aufruft, während ein fehlender Parameter nicht der Fall ist.
Beispiel für die Verwendung von coerce_with mit einer Lambda (eine Klasse mit einer parse -Methode könnte auch verwendet worden sein) wird eine Zeichenfolge analysiert und ein Array von ganzen Zahlen zurückgibt, wobei der Array[Integer] type entspricht.
params do
requires :values , type : Array [ Integer ] , coerce_with : -> ( val ) { val . split ( / s +/ ) . map ( & :to_i ) }
end Die Traube behauptet, dass Zwangswerte dem angegebenen type übereinstimmen, und lehnt die Anfrage ab, wenn dies nicht der Fall ist. Um dieses Verhalten zu überschreiben, können benutzerdefinierte Typen eine parsed? Methode, die ein einzelnes Argument akzeptieren und true zurückgeben sollte, wenn der Wert die Typvalidierung übergibt.
class SecureUri
def self . parse ( value )
URI . parse value
end
def self . parsed? ( value )
value . is_a? URI :: HTTPS
end
end
params do
requires :secure_uri , type : SecureUri
end Die integrierte Unterstützung von Rack::Request nutzt die integrierte Unterstützung für Multipart-Dateiparameter. Solche Parameter können mit type: File deklariert werden:
params do
requires :avatar , type : File
end
post '/' do
params [ :avatar ] [ :filename ] # => 'avatar.png'
params [ :avatar ] [ :type ] # => 'image/png'
params [ :avatar ] [ :tempfile ] # => #<File>
endJSON Typen Traube unterstützt komplexe Parameter, die als JSON-formatierte Zeichenfolgen unter Verwendung des speziellen type: JSON Deklaration angegeben werden. JSON -Objekte und -Arrays von Objekten werden gleichermaßen akzeptiert, wobei verschachtelte Validierungsregeln in beiden Fällen auf alle Objekte angewendet werden:
params do
requires :json , type : JSON do
requires :int , type : Integer , values : [ 1 , 2 , 3 ]
end
end
get '/' do
params [ :json ] . inspect
end
client . get ( '/' , json : '{"int":1}' ) # => "{:int=>1}"
client . get ( '/' , json : '[{"int":"1"}]' ) # => "[{:int=>1}]"
client . get ( '/' , json : '{"int":4}' ) # => HTTP 400
client . get ( '/' , json : '[{"int":4}]' ) # => HTTP 400 Zusätzlich type: Array[JSON] kann verwendet werden, was den Parameter als Array von Objekten explizit markiert. Wenn ein einzelnes Objekt geliefert wird, wird es verpackt.
params do
requires :json , type : Array [ JSON ] do
requires :int , type : Integer
end
end
get '/' do
params [ :json ] . each { | obj | ... } # always works
end Verwenden Sie für die strengere Kontrolle über die Art der JSON -Struktur, die geliefert werden kann, type: Array, coerce_with: JSON oder type: Hash, coerce_with: JSON .
Parameter vom Varianten-Typ können mithilfe der Option types " deklariert werden als type :
params do
requires :status_code , types : [ Integer , String , Array [ Integer , String ] ]
end
get '/' do
params [ :status_code ] . inspect
end
client . get ( '/' , status_code : 'OK_GOOD' ) # => "OK_GOOD"
client . get ( '/' , status_code : 300 ) # => 300
client . get ( '/' , status_code : %w( 404 NOT FOUND ) ) # => [404, "NOT", "FOUND"] Als Sonderfall können auch Sammlungen vom Varianten-Member-Typ deklariert werden, indem ein Set oder ein Array mit mehr als einem Mitglied übergeben wird, um zu type :
params do
requires :status_codes , type : Array [ Integer , String ]
end
get '/' do
params [ :status_codes ] . inspect
end
client . get ( '/' , status_codes : %w( 1 two ) ) # => [1, "two"] Parameter können mit group oder per Aufrufen requires oder optional mit einem Block verschachtelt werden. Im obigen Beispiel bedeutet dies params[:media][:url] zusammen mit params[:id] und params[:audio][:format] nur dann erforderlich, wenn params[:audio] vorhanden sind. Mit einem Block, group , requires und optional akzeptieren Sie einen zusätzlichen type , der entweder Array oder Hash und Standard für Array sein kann. Abhängig vom Wert werden die verschachtelten Parameter entweder als Werte eines Hashs oder als Werte von Hashes in einem Array behandelt.
params do
optional :preferences , type : Array do
requires :key
requires :value
end
requires :name , type : Hash do
requires :first_name
requires :last_name
end
end Angenommen, einige Ihrer Parameter sind nur relevant, wenn ein anderer Parameter angegeben ist. Mit Traube können Sie diese Beziehung durch die given Methode in Ihrem Parameterblock ausdrücken, wie dies:
params do
optional :shelf_id , type : Integer
given :shelf_id do
requires :bin_id , type : Integer
end
end Im obigen Beispiel wird Traube blank? Um zu überprüfen, ob der Param shelf_id vorhanden ist.
given auch ein Proc mit benutzerdefiniertem Code. Nachfolgend ist die Param description nur erforderlich, wenn der Wert der category gleich foo ist:
params do
optional :category
given category : -> ( val ) { val == 'foo' } do
requires :description
end
endSie können Parameter umbenennen:
params do
optional :category , as : :type
given type : -> ( val ) { val == 'foo' } do
requires :description
end
end HINWEIS: Der Param sollte der umbenannte given sein. Im Beispiel sollte es type und keine category sein.
Parameteroptionen können gruppiert werden. Es kann nützlich sein, wenn Sie gemeinsame Validierung oder Typen für mehrere Parameter extrahieren möchten. Innerhalb dieser Gruppen können einzelne Parameter die gemeinsamen Einstellungen erweitern oder selektiv überschreiben, sodass Sie die Standardeinstellungen auf Gruppenebene beibehalten und gleichzeitig parameterspezifische Regeln anwenden können.
Das folgende Beispiel zeigt einen typischen Fall, wenn die Parameter gemeinsame Optionen teilen.
params do
requires :first_name , type : String , regexp : /w+/ , desc : 'First name' , documentation : { in : 'body' }
optional :middle_name , type : String , regexp : /w+/ , desc : 'Middle name' , documentation : { in : 'body' , x : { nullable : true } }
requires :last_name , type : String , regexp : /w+/ , desc : 'Last name' , documentation : { in : 'body' }
end Mit der Traube können Sie dieselbe Logik durch die with Methode in Ihrem Parameterblock vorliegende Logik präsentieren, wie so:
params do
with ( type : String , regexp : /w+/ , documentation : { in : 'body' } ) do
requires :first_name , desc : 'First name'
optional :middle_name , desc : 'Middle name' , documentation : { x : { nullable : true } }
requires :last_name , desc : 'Last name'
end
endSie können Einstellungen mit verschachtelten "mit" Blöcken in Ebenen organisieren. Jede Ebene kann die Einstellungen der Ebene darüber verwenden, hinzufügen oder ändern. Dies hilft, komplexe Parameter organisiert und konsistent zu halten und gleichzeitig bestimmte Anpassungen vorzunehmen.
params do
with ( documentation : { in : 'body' } ) do # Applies documentation to all nested parameters
with ( type : String , regexp : / w +/ ) do # Applies type and validation to names
requires :first_name , desc : 'First name'
requires :last_name , desc : 'Last name'
end
optional :age , type : Integer , desc : 'Age' , documentation : { x : { nullable : true } } # Specific settings for 'age'
end
end Sie können Parameter mit as umbenennen, was bei der Wiederbelebung vorhandener APIs nützlich sein kann:
resource :users do
params do
requires :email_address , as : :email
requires :password
end
post do
User . create! ( declared ( params ) ) # User takes email and password
end
end Der Wert, as den Schlüssel übergeben wird, wird beim Aufrufen declared(params) .
allow_blank Parameter können als allow_blank definiert werden, um sicherzustellen, dass sie einen Wert enthalten. Standardmäßig requires nur bestätigt werden, dass ein Parameter in die Anfrage gesendet wurde, unabhängig von seinem Wert. Mit allow_blank: false , leere Werte oder Whitespace Nur Werte sind ungültig.
allow_blank kann mit beiden requires und optional kombiniert werden. Wenn der Parameter erforderlich ist, muss er einen Wert enthalten. Wenn es optional ist, ist es möglich, es nicht in die Anfrage zu senden, aber wenn es gesendet wird, muss es einen gewissen Wert haben und keine leere Zeichenfolge/nur eine Weißespace.
params do
requires :username , allow_blank : false
optional :first_name , allow_blank : false
end values Parameter können mit der Option :values auf eine bestimmte Wertemenge beschränkt werden.
params do
requires :status , type : Symbol , values : [ :not_started , :processing , :done ]
optional :numbers , type : Array [ Integer ] , default : 1 , values : [ 1 , 2 , 3 , 5 , 8 ]
end Durch die Lieferung eines Bereichs an die Option :values stellt sicher, dass der Parameter (oder Parameter) in diesem Bereich enthalten ist (unter Verwendung von Range#include? ).
params do
requires :latitude , type : Float , values : - 90.0 ..+ 90.0
requires :longitude , type : Float , values : - 180.0 ..+ 180.0
optional :letters , type : Array [ String ] , values : 'a' .. 'z'
endBeachten Sie, dass endlose Bereiche auch mit Activesupport> = 6.0 unterstützt werden, aber sie erfordern, dass der Typ bereitgestellt wird.
params do
requires :minimum , type : Integer , values : 10 ..
optional :maximum , type : Integer , values : .. 10
end Beachten Sie, dass beide Bereichs Endpunkte ein #kind_of? Ihre Option :type Option ein (wenn Sie die Option :type nicht angeben, ist sie vermutet, dass sie der Klasse des ersten Endpunkts des Bereichs entspricht). Das Folgende ist also ungültig:
params do
requires :invalid1 , type : Float , values : 0 .. 10 # 0.kind_of?(Float) => false
optional :invalid2 , values : 0 .. 10.0 # 10.0.kind_of?(0.class) => false
end Die Option :values kann auch mit einem Proc geliefert werden, der bei jeder Anfrage träge bewertet wird. Wenn der Proc. Arity Zero hat (dh es dauert keine Argumente), wird erwartet, dass es entweder eine Liste oder einen Bereich zurückgibt, mit dem der Parameter validiert wird.
Angesichts eines Statusmodells möchten Sie beispielsweise durch Hashtags einschränken, die Sie zuvor im HashTag -Modell definiert haben.
params do
requires :hashtag , type : String , values : -> { Hashtag . all . map ( & :tag ) }
endAlternativ kann ein Proc mit Arity One (dh ein Argument) verwendet werden, um jeden Parameterwert explizit zu validieren. In diesem Fall wird erwartet, dass der Proc einen Wahrheitswert zurücksetzt, wenn der Parameterwert gültig ist. Der Parameter wird als ungültig angesehen, wenn der ProC einen falsy -Wert zurückgibt oder wenn er einen StandardError erhöht.
params do
requires :number , type : Integer , values : -> ( v ) { v . even? && v < 25 }
endWährend Procs für einzelne Fälle bequem sind, sollten Sie benutzerdefinierte Validatoren in Fällen verwenden, in denen eine Validierung mehr als einmal verwendet wird.
Beachten Sie, dass der Validator für Den_Blank bei Verwendung :values gilt. Im folgenden Beispiel verhindert das Fehlen von :allow_blank nicht :state leere Werte, da :allow_blank standardnaug an true .
params do
requires :state , type : Symbol , values : [ :active , :inactive ]
end except_values Die Parameter können mit der Option :except_values der Values eine bestimmte Wertemenge beschränkt werden.
Der Validator except_values verhält sich ähnlich wie der values -Validator, indem er entweder ein Array, einen Bereich oder einen Proc akzeptiert. Im Gegensatz zum values -Validator akzeptiert except_values jedoch nur Procs mit Arity Zero.
params do
requires :browser , except_values : [ 'ie6' , 'ie7' , 'ie8' ]
requires :port , except_values : { value : 0 .. 1024 , message : 'is not allowed' }
requires :hashtag , except_values : -> { Hashtag . FORBIDDEN_LIST }
end same_as Eine Option same_as kann angegeben werden, um sicherzustellen, dass die Werte von Parametern übereinstimmen.
params do
requires :password
requires :password_confirmation , same_as : :password
end length Parameter mit Typen, die #length -Methode unterstützen, können auf eine bestimmte Länge mit der Option :length beschränkt werden.
Der Validator akzeptiert :min oder :max oder beides Optionen oder nur :is zu validieren, dass der Wert des Parameters innerhalb der angegebenen Grenzen liegt.
params do
requires :code , type : String , length : { is : 2 }
requires :str , type : String , length : { min : 3 }
requires :list , type : [ Integer ] , length : { min : 3 , max : 5 }
requires :hash , type : Hash , length : { max : 5 }
end regexp Parameter können auf einen bestimmten regulären Ausdruck mit der Option :regexp übereinstimmen. Wenn der Wert nicht mit dem regulären Ausdruck übereinstimmt, wird ein Fehler zurückgegeben. Beachten Sie, dass dies für die requires und optional Parameter gilt.
params do
requires :email , regexp : /.+@.+/
end Der Validator passt, wenn der Parameter ohne Wert gesendet wurde. Um sicherzustellen, dass der Parameter einen Wert enthält, verwenden Sie allow_blank: false .
params do
requires :email , allow_blank : false , regexp : /.+@.+/
end mutually_exclusive Parameter können als mutually_exclusive definiert werden, um sicherzustellen, dass sie in einer Anfrage nicht gleichzeitig vorhanden sind.
params do
optional :beer
optional :wine
mutually_exclusive :beer , :wine
endMehrere Sets können definiert werden:
params do
optional :beer
optional :wine
mutually_exclusive :beer , :wine
optional :scotch
optional :aquavit
mutually_exclusive :scotch , :aquavit
endWARNUNG : Definieren Sie niemals gegenseitig ausschließende Sätze mit allen erforderlichen Params. Zwei gegenseitig ausschließende erforderliche Parameter bedeuten, dass Parameter niemals gültig sind, wodurch der Endpunkt unbrauchbar wird. Ein erforderlicher Param, der sich gegenseitig ausschließt, bedeutet, dass der letztere niemals gültig ist.
exactly_one_ofParameter können als "exakt_one_of" definiert werden, um sicherzustellen, dass genau ein Parameter ausgewählt wird.
params do
optional :beer
optional :wine
exactly_one_of :beer , :wine
end Beachten Sie, dass die Verwendung :default mit mutually_exclusive dazu führt, dass mehrere Parameter immer einen Standardwert haben und eine Grape::Exceptions::Validation gegenseitig ausschließend.
at_least_one_ofParameter können als "at_least_one_of" definiert werden, um sicherzustellen, dass mindestens ein Parameter ausgewählt wird.
params do
optional :beer
optional :wine
optional :juice
at_least_one_of :beer , :wine , :juice
end all_or_none_ofParameter können als "All_OR_NONE_OF" definiert werden, um sicherzustellen, dass alle oder keine Parameter ausgewählt werden.
params do
optional :beer
optional :wine
optional :juice
all_or_none_of :beer , :wine , :juice
end mutually_exclusive , exactly_one_of , at_least_one_of , all_or_none_ofAlle diese Methoden können auf jeder verschachtelten Ebene angewendet werden.
params do
requires :food , type : Hash do
optional :meat
optional :fish
optional :rice
at_least_one_of :meat , :fish , :rice
end
group :drink , type : Hash do
optional :beer
optional :wine
optional :juice
exactly_one_of :beer , :wine , :juice
end
optional :dessert , type : Hash do
optional :cake
optional :icecream
mutually_exclusive :cake , :icecream
end
optional :recipe , type : Hash do
optional :oil
optional :meat
all_or_none_of :oil , :meat
end
endNamespaces erlauben Parameterdefinitionen und gilt für jede Methode im Namespace.
namespace :statuses do
params do
requires :user_id , type : Integer , desc : 'A user ID.'
end
namespace ':user_id' do
desc "Retrieve a user's status."
params do
requires :status_id , type : Integer , desc : 'A status ID.'
end
get ':status_id' do
User . find ( params [ :user_id ] ) . statuses . find ( params [ :status_id ] )
end
end
end Die namespace -Methode enthält eine Reihe von Aliase, darunter: group , resource , resources und segment . Verwenden Sie das, was auch immer das Beste für Ihre API liest.
Sie können einen Routenparameter bequem als Namespace mit route_param definieren.
namespace :statuses do
route_param :id do
desc 'Returns all replies for a status.'
get 'replies' do
Status . find ( params [ :id ] ) . replies
end
desc 'Returns a status.'
get do
Status . find ( params [ :id ] )
end
end
end Sie können auch einen Routenparametertyp definieren, indem Sie an die Optionen von route_param weitergeben.
namespace :arithmetic do
route_param :n , type : Integer do
desc 'Returns in power'
get 'power' do
params [ :n ] ** params [ :n ]
end
end
end class AlphaNumeric < Grape :: Validations :: Validators :: Base
def validate_param! ( attr_name , params )
unless params [ attr_name ] =~ / A [[:alnum:]]+ z /
raise Grape :: Exceptions :: Validation . new params : [ @scope . full_name ( attr_name ) ] , message : 'must consist of alpha-numeric characters'
end
end
end params do
requires :text , alpha_numeric : true
endSie können auch benutzerdefinierte Klassen erstellen, die Parameter einnehmen.
class Length < Grape :: Validations :: Validators :: Base
def validate_param! ( attr_name , params )
unless params [ attr_name ] . length <= @option
raise Grape :: Exceptions :: Validation . new params : [ @scope . full_name ( attr_name ) ] , message : "must be at the most #{ @option } characters long"
end
end
end params do
requires :text , length : 140
endSie können auch eine benutzerdefinierte Validierung erstellen, mit der die Anforderung zur Validierung des Attributs verwendet wird. Wenn Sie beispielsweise Parameter haben möchten, die nur Administratoren zur Verfügung stehen, können Sie Folgendes tun.
class Admin < Grape :: Validations :: Validators :: Base
def validate ( request )
# return if the param we are checking was not in request
# @attrs is a list containing the attribute we are currently validating
# in our sample case this method once will get called with
# @attrs being [:admin_field] and once with @attrs being [:admin_false_field]
return unless request . params . key? ( @attrs . first )
# check if admin flag is set to true
return unless @option
# check if user is admin or not
# as an example get a token from request and check if it's admin or not
raise Grape :: Exceptions :: Validation . new params : @attrs , message : 'Can not set admin-only field.' unless request . headers [ 'X-Access-Token' ] == 'admin'
end
endUnd verwenden Sie es in Ihrer Endpunktdefinition als:
params do
optional :admin_field , type : String , admin : true
optional :non_admin_field , type : String
optional :admin_false_field , type : String , admin : false
endJede Validierung hat eine eigene Instanz des Validators, was bedeutet, dass der Validator einen Zustand haben kann.
Validierungs- und Zwangsfehler werden gesammelt und eine Ausnahme von Grape::Exceptions::ValidationErrors wird erhöht. Wenn die Ausnahme nicht erfasst wird, wird sie mit einem Status von 400 und einer Fehlermeldung reagieren. Die Validierungsfehler werden nach Parametername gruppiert und können über Grape::Exceptions::ValidationErrors#errors zugegriffen werden.
Die Standardantwort einer Grape::Exceptions::ValidationErrors ist eine menschlich lesbare Schnur wie "Bier, Wein sind gegenseitig ausschließt".
params do
optional :beer
optional :wine
optional :juice
exactly_one_of :beer , :wine , :juice
end Sie können eine Grape::Exceptions::ValidationErrors und reagieren mit einer benutzerdefinierten Antwort oder verwandeln die Antwort in gut formatierte JSON für eine JSON-API, die einzelne Parameter und die entsprechenden Fehlermeldungen trennt. Das folgende Beispiel rescue_from erzeugt [{"params":["beer","wine"],"messages":["are mutually exclusive"]}] .
format :json
subject . rescue_from Grape :: Exceptions :: ValidationErrors do | e |
error! e , 400
end Grape::Exceptions::ValidationErrors#full_messages gibt die Validierungsmeldungen als Array zurück. Grape::Exceptions::ValidationErrors#message verbinden sich den Nachrichten zu einer Zeichenfolge.
Um mit einer Reihe von Validierungsnachrichten zu antworten, können Sie Grape::Exceptions::ValidationErrors#full_messages verwenden.
format :json
subject . rescue_from Grape :: Exceptions :: ValidationErrors do | e |
error! ( { messages : e . full_messages } , 400 )
end Die Traube gibt alle standardmäßigen Validierungs- und Zwangsfehler zurück. Um alle nachfolgenden Validierungsüberprüfungen zu überspringen, wenn ein bestimmter Param für ungültig ist, verwenden Sie fail_fast: true .
Das folgende Beispiel wird nicht prüfen, ob :wine vorhanden ist, es sei denn, er findet :beer .
params do
required :beer , fail_fast : true
required :wine
end Das Ergebnis leerer Parameter wäre eine einzelne Grape::Exceptions::ValidationErrors -Fehler.
In ähnlicher Weise wird kein regulärer Expressionstest durchgeführt, wenn :blah im folgenden Beispiel leer ist.
params do
required :blah , allow_blank : false , regexp : /blah/ , fail_fast : true
endGrape unterstützt I18N für parameterbezogene Fehlermeldungen, fällt jedoch in Englisch zurück, wenn keine Übersetzungen für das Standard-Gebietsschema bereitgestellt wurden. Siehe EN.YML für Nachrichtenschlüsseln.
Wenn Ihre App nur die verfügbaren Orte durchsetzt und: EN nicht in Ihren verfügbaren Orten enthalten ist, kann Traube nicht auf Englisch zurückfallen und gibt den Übersetzungsschlüssel für die Fehlermeldung zurück. Um dieses Verhalten zu vermeiden, geben Sie entweder eine Übersetzung für Ihr Standard -Gebietsschema oder fügen Sie zu Ihren verfügbaren Orten hinzu.
GREPE unterstützt benutzerdefinierte Validierungsmeldungen für Parameterbezogene und crosbezogene Fehlermeldungen.
presence , allow_blank , values , regexp params do
requires :name , values : { value : 1 .. 10 , message : 'not in range from 1 to 10' } , allow_blank : { value : false , message : 'cannot be blank' } , regexp : { value : /^[a-z]+$/ , message : 'format is invalid' } , message : 'is required'
end same_as params do
requires :password
requires :password_confirmation , same_as : { value : :password , message : 'not match' }
end length params do
requires :code , type : String , length : { is : 2 , message : 'code is expected to be exactly 2 characters long' }
requires :str , type : String , length : { min : 5 , message : 'str is expected to be atleast 5 characters long' }
requires :list , type : [ Integer ] , length : { min : 2 , max : 3 , message : 'list is expected to have between 2 and 3 elements' }
end all_or_none_of params do
optional :beer
optional :wine
optional :juice
all_or_none_of :beer , :wine , :juice , message : "all params are required or none is required"
end mutually_exclusive params do
optional :beer
optional :wine
optional :juice
mutually_exclusive :beer , :wine , :juice , message : "are mutually exclusive cannot pass both params"
end exactly_one_of params do
optional :beer
optional :wine
optional :juice
exactly_one_of :beer , :wine , :juice , message : { exactly_one : "are missing, exactly one parameter is required" , mutual_exclusion : "are mutually exclusive, exactly one parameter is required" }
end at_least_one_of params do
optional :beer
optional :wine
optional :juice
at_least_one_of :beer , :wine , :juice , message : "are missing, please specify at least one param"
end Coerce params do
requires :int , type : { value : Integer , message : "type cast is invalid" }
end With Lambdas params do
requires :name , values : { value : -> { ( 1 .. 10 ) . to_a } , message : 'not in range from 1 to 10' }
end Pass symbols for i18n translationsSie können ein Symbol übergeben, wenn Sie I18N -Übersetzungen für Ihre benutzerdefinierten Validierungsnachrichten wünschen.
params do
requires :name , message : :name_required
end # en.yml
en :
grape :
errors :
format : ! '%{attributes} %{message}'
messages :
name_required : 'must be present' Sie können auch Attributnamen überschreiben.
# en.yml
en :
grape :
errors :
format : ! '%{attributes} %{message}'
messages :
name_required : 'must be present'
attributes :
name : 'Oops! Name'Wird 'oops produzieren! Name muss anwesend sein '
Sie können keine benutzerdefinierte Meldungsoption für die Standardeinstellung festlegen, da Interpolation %{option1}: %{value1} is incompatible with %{option2}: %{value2} . Sie können die Standardfehlermeldung für die Standardeinstellung ändern, indem Sie den Nachrichtenschlüssel incompatible_option_values in en.yml ändern
params do
requires :name , values : { value : -> { ( 1 .. 10 ) . to_a } , message : 'not in range from 1 to 10' } , default : 5
enddry-validation oder dry-schema Als Alternative zu den oben beschriebenen params DSL können Sie ein Schema oder einen dry-validation verwenden, um die Parameter eines Endpunkts zu beschreiben. Dies kann besonders nützlich sein, wenn Sie die oben genannten bereits in einigen anderen Teilen Ihrer Anwendung verwenden. Wenn nicht, müssen Sie Ihrem Gemfile dry-validation oder dry-schema hinzufügen.
Rufen Sie dann contract mit einem zuvor definierten Vertrag oder einem Schema an:
CreateOrdersSchema = Dry :: Schema . Params do
required ( :orders ) . array ( :hash ) do
required ( :name ) . filled ( :string )
optional ( :volume ) . maybe ( :integer , lt? : 9 )
end
end
# ...
contract CreateOrdersSchemaoder mit einem Block mit der Schema -Definitionsyntax:
contract do
required ( :orders ) . array ( :hash ) do
required ( :name ) . filled ( :string )
optional ( :volume ) . maybe ( :integer , lt? : 9 )
end
end Letzteres definiert ein Zwangschema ( Dry::Schema.Params ). Bei der Verwendung des früheren Ansatzes liegt es an Ihnen, zu entscheiden, ob die Eingabe zwingen muss.
Die params und contract können auch zusammen in derselben API verwendet werden, z. B. um verschiedene Teile eines verschachtelten Namespace für einen Endpunkt zu beschreiben.
Anfrage Header sind in ihrer ursprünglichen Form über den headers -Helfer oder von env erhältlich.
get do
error! ( 'Unauthorized' , 401 ) unless headers [ 'Secret-Password' ] == 'swordfish'
end get do
error! ( 'Unauthorized' , 401 ) unless env [ 'HTTP_SECRET_PASSWORD' ] == 'swordfish'
end Das obige Beispiel wurde möglicherweise wie folgt angefordert:
curl -H " secret_PassWord: swordfish " ...Der Header -Name wurde für Sie normalisiert.
header werden Helfernamen in ein Downcased Kebab Case als secret-password gezwungen, wenn Rack 3 verwendet wird.header werden Helfernamen zu einem kapitalisierten Kebab-Fall als Secret-PassWord gezwungen, wenn sie Rack <3 verwendet.env -Sammlung erscheinen sie in allen Großbuchstaben, im Schlangenfall und mit 'http_' als HTTP_SECRET_PASSWORD vorangestelltDer Header -Name wurde gemäß HTTP -Standards, die in RFC2616 -Abschnitt 4.2 definiert wurden, unabhängig davon, was von einem Kunden gesendet wird, normalisiert.
Sie können einen Antwortheader mit header in einer API einstellen.
header 'X-Robots-Tag' , 'noindex' Bei der Erhöhung error! übergeben Sie zusätzliche Header als Argumente. Zusätzliche Header werden mit den Headern verschmolzen, die vor error! Anruf.
error! 'Unauthorized' , 401 , 'X-Error-Detail' => 'Invalid token.' Um Routen zu definieren, können Sie die route oder die Abkürzungen für die HTTP -Verben verwenden. Definieren Sie eine Route, die eine beliebige Route akzeptiert auf :any . Teile des Pfades, die mit einem Dickdarm bezeichnet werden, werden als Routenparameter interpretiert.
route :get , 'status' do
end
# is the same as
get 'status' do
end
# is the same as
get :status do
end
# is NOT the same as
get ':status' do # this makes params[:status] available
end
# This will make both params[:status_id] and params[:id] available
get 'statuses/:status_id/reviews/:id' do
end Verwenden Sie die namespace -Methode, um einen Namespace zu deklarieren, der alle Wege innerhalb der Inneren vorfixiert. group , resource , resources und segment sind Aliase dieser Methode. Alle Endpunkte innerhalb werden ihren übergeordneten Kontext sowie jede Konfiguration im Namenspace -Kontext weitergeben.
Die Methode route_param ist eine bequeme Methode zum Definieren eines Parameterroutensegments. Wenn Sie einen Typ definieren, wird eine Validierung für diesen Parameter hinzugefügt.
route_param :id , type : Integer do
get 'status' do
end
end
# is the same as
namespace ':id' do
params do
requires :id , type : Integer
end
get 'status' do
end
endOptional können Sie die Anforderungen für Ihre benannten Routenparameter unter Verwendung regelmäßiger Ausdrücke im Namespace oder Endpunkt definieren. Die Route entspricht nur, wenn alle Anforderungen erfüllt sind.
get ':id' , requirements : { id : /[0-9]*/ } do
Status . find ( params [ :id ] )
end
namespace :outer , requirements : { id : /[0-9]*/ } do
get :id do
end
get ':id/edit' do
end
end Sie können Helfermethoden definieren, die Ihre Endpunkte mit dem helpers -Makro verwenden können, indem Sie entweder einen Block oder eine Reihe von Modulen geben.
module StatusHelpers
def user_info ( user )
" #{ user } has statused #{ user . statuses } status(s)"
end
end
module HttpCodesHelpers
def unauthorized
401
end
end
class API < Grape :: API
# define helpers with a block
helpers do
def current_user
User . find ( params [ :user_id ] )
end
end
# or mix in an array of modules
helpers StatusHelpers , HttpCodesHelpers
before do
error! ( 'Access Denied' , unauthorized ) unless current_user
end
get 'info' do
# helpers available in your endpoint and filters
user_info ( current_user )
end
end Sie können wiederverwendbare params mithilfe von helpers definieren.
class API < Grape :: API
helpers do
params :pagination do
optional :page , type : Integer
optional :per_page , type : Integer
end
end
desc 'Get collection'
params do
use :pagination # aliases: includes, use_scope
end
get do
Collection . page ( params [ :page ] ) . per ( params [ :per_page ] )
end
end Sie können auch wiederverwendbare params mithilfe gemeinsamer Helfer definieren.
module SharedParams
extend Grape :: API :: Helpers
params :period do
optional :start_date
optional :end_date
end
params :pagination do
optional :page , type : Integer
optional :per_page , type : Integer
end
end
class API < Grape :: API
helpers SharedParams
desc 'Get collection.'
params do
use :period , :pagination
end
get do
Collection
. from ( params [ :start_date ] )
. to ( params [ :end_date ] )
. page ( params [ :page ] )
. per ( params [ :per_page ] )
end
end Helfer unterstützen Blöcke, mit denen Standardwerte festgelegt werden können. Die folgende API kann eine Sammlung zurückgeben, sortiert nach id oder created_at in asc oder desc -Bestellung.
module SharedParams
extend Grape :: API :: Helpers
params :order do | options |
optional :order_by , type : Symbol , values : options [ :order_by ] , default : options [ :default_order_by ]
optional :order , type : Symbol , values : %i( asc desc ) , default : options [ :default_order ]
end
end
class API < Grape :: API
helpers SharedParams
desc 'Get a sorted collection.'
params do
use :order , order_by : %i( id created_at ) , default_order_by : :created_at , default_order : :asc
end
get do
Collection . send ( params [ :order ] , params [ :order_by ] )
end
end Wenn Sie Methoden zum Generieren von Pfaden in Ihren Endpunkten benötigen, finden Sie im Juwel des Get-Route-Helpers.
Mit einem documentation -Hash können Sie zusätzliche Dokumentation an params anhängen.
params do
optional :first_name , type : String , documentation : { example : 'Jim' }
requires :last_name , type : String , documentation : { example : 'Smith' }
endWenn die Dokumentation nicht erforderlich ist (z. B. eine interne API), kann die Dokumentation deaktiviert werden.
class API < Grape :: API
do_not_document!
# endpoints...
endIn diesem Fall werden Traube keine Objekte erstellt, die sich auf Dokumentation beziehen, die in RAM für immer beibehalten werden.
Sie können Ihre Cookies einfach einstellen, abrufen und löschen, indem Sie cookies -Methode verwenden.
class API < Grape :: API
get 'status_count' do
cookies [ :status_count ] ||= 0
cookies [ :status_count ] += 1
{ status_count : cookies [ :status_count ] }
end
delete 'status_count' do
{ status_count : cookies . delete ( :status_count ) }
end
endVerwenden Sie eine Hash-basierte Syntax, um mehr als einen Wert festzulegen.
cookies [ :status_count ] = {
value : 0 ,
expires : Time . tomorrow ,
domain : '.twitter.com' ,
path : '/'
}
cookies [ :status_count ] [ :value ] += 1 Löschen Sie einen Keks mit delete .
cookies . delete :status_countGeben Sie einen optionalen Pfad an.
cookies . delete :status_count , path : '/' Standardmäßig gibt Traube einen 201 für POST -Requests, 204 für DELETE -Erzählungen zurück, die keinen Inhalt zurückgeben, und 200 Statuscode für alle anderen Anforderungen. Sie können status zur Abfrage verwenden und den tatsächlichen HTTP -Statuscode festlegen
post do
status 202
if status == 200
# do some thing
end
endYou can also use one of status codes symbols that are provided by Rack utils
post do
status :no_content
end You can redirect to a new url temporarily (302) or permanently (301).
redirect '/statuses' redirect '/statuses' , permanent : true You can recognize the endpoint matched with given path.
This API returns an instance of Grape::Endpoint .
class API < Grape :: API
get '/statuses' do
end
end
API . recognize_path '/statuses' Since version 2.1.0 , the recognize_path method takes into account the parameters type to determine which endpoint should match with given path.
class Books < Grape :: API
resource :books do
route_param :id , type : Integer do
# GET /books/:id
get do
#...
end
end
resource :share do
# POST /books/share
post do
# ....
end
end
end
end
API . recognize_path '/books/1' # => /books/:id
API . recognize_path '/books/share' # => /books/share
API . recognize_path '/books/other' # => nil When you add a GET route for a resource, a route for the HEAD method will also be added automatically. You can disable this behavior with do_not_route_head! .
class API < Grape :: API
do_not_route_head!
get '/example' do
# only responds to GET
end
end When you add a route for a resource, a route for the OPTIONS method will also be added. The response to an OPTIONS request will include an "Allow" header listing the supported methods. If the resource has before and after callbacks they will be executed, but no other callbacks will run.
class API < Grape :: API
get '/rt_count' do
{ rt_count : current_user . rt_count }
end
params do
requires :value , type : Integer , desc : 'Value to add to the rt count.'
end
put '/rt_count' do
current_user . rt_count += params [ :value ] . to_i
{ rt_count : current_user . rt_count }
end
end curl -v -X OPTIONS http://localhost:3000/rt_count
> OPTIONS /rt_count HTTP/1.1
>
< HTTP/1.1 204 No Content
< Allow: OPTIONS, GET, PUT You can disable this behavior with do_not_route_options! .
If a request for a resource is made with an unsupported HTTP method, an HTTP 405 (Method Not Allowed) response will be returned. If the resource has before callbacks they will be executed, but no other callbacks will run.
curl -X DELETE -v http://localhost:3000/rt_count/
> DELETE /rt_count/ HTTP/1.1
> Host: localhost:3000
>
< HTTP/1.1 405 Method Not Allowed
< Allow: OPTIONS, GET, PUT You can abort the execution of an API method by raising errors with error! .
error! 'Access Denied' , 401 Anything that responds to #to_s can be given as a first argument to error! .
error! :not_found , 404You can also return JSON formatted objects by raising error! and passing a hash instead of a message.
error! ( { error : 'unexpected error' , detail : 'missing widget' } , 500 ) You can set additional headers for the response. They will be merged with headers set before error! Anruf.
error! ( 'Something went wrong' , 500 , 'X-Error-Detail' => 'Invalid token.' )You can present documented errors with a Grape entity using the the grape-entity gem.
module API
class Error < Grape :: Entity
expose :code
expose :message
end
end The following example specifies the entity to use in the http_codes definition.
desc 'My Route' do
failure [ [ 408 , 'Unauthorized' , API :: Error ] ]
end
error! ( { message : 'Unauthorized' } , 408 )The following example specifies the presented entity explicitly in the error message.
desc 'My Route' do
failure [ [ 408 , 'Unauthorized' ] ]
end
error! ( { message : 'Unauthorized' , with : API :: Error } , 408 ) By default Grape returns a 500 status code from error! . You can change this with default_error_status .
class API < Grape :: API
default_error_status 400
get '/example' do
error! 'This should have http status code 400'
end
endFor Grape to handle all the 404s for your API, it can be useful to use a catch-all. In its simplest form, it can be like:
route :any , '*path' do
error! # or something else
endIt is very crucial to define this endpoint at the very end of your API , as it literally accepts every request.
Grape can be told to rescue all StandardError exceptions and return them in the API format.
class Twitter :: API < Grape :: API
rescue_from :all
end This mimics default rescue behaviour when an exception type is not provided. Any other exception should be rescued explicitly, see below.
Grape can also rescue from all exceptions and still use the built-in exception handing. This will give the same behavior as rescue_from :all with the addition that Grape will use the exception handling defined by all Exception classes that inherit Grape::Exceptions::Base .
The intent of this setting is to provide a simple way to cover the most common exceptions and return any unexpected exceptions in the API format.
class Twitter :: API < Grape :: API
rescue_from :grape_exceptions
end If you want to customize the shape of grape exceptions returned to the user, to match your :all handler for example, you can pass a block to rescue_from :grape_exceptions .
rescue_from :grape_exceptions do | e |
error! ( e , e . status )
endYou can also rescue specific exceptions.
class Twitter :: API < Grape :: API
rescue_from ArgumentError , UserDefinedError
end In this case UserDefinedError must be inherited from StandardError .
Notice that you could combine these two approaches (rescuing custom errors takes precedence). For example, it's useful for handling all exceptions except Grape validation errors.
class Twitter :: API < Grape :: API
rescue_from Grape :: Exceptions :: ValidationErrors do | e |
error! ( e , 400 )
end
rescue_from :all
endThe error format will match the request format. See "Content-Types" below.
Custom error formatters for existing and additional types can be defined with a proc.
class Twitter :: API < Grape :: API
error_formatter :txt , -> ( message , backtrace , options , env , original_exception ) {
"error: #{ message } from #{ backtrace } "
}
endYou can also use a module or class.
module CustomFormatter
def self . call ( message , backtrace , options , env , original_exception )
{ message : message , backtrace : backtrace }
end
end
class Twitter :: API < Grape :: API
error_formatter :custom , CustomFormatter
end You can rescue all exceptions with a code block. The error! wrapper automatically sets the default error code and content-type.
class Twitter :: API < Grape :: API
rescue_from :all do | e |
error! ( "rescued from #{ e . class . name } " )
end
endOptionally, you can set the format, status code and headers.
class Twitter :: API < Grape :: API
format :json
rescue_from :all do | e |
error! ( { error : 'Server error.' } , 500 , { 'Content-Type' => 'text/error' } )
end
endYou can also rescue all exceptions with a code block and handle the Rack response at the lowest level.
class Twitter :: API < Grape :: API
rescue_from :all do | e |
Rack :: Response . new ( [ e . message ] , 500 , { 'Content-type' => 'text/error' } )
end
endOr rescue specific exceptions.
class Twitter :: API < Grape :: API
rescue_from ArgumentError do | e |
error! ( "ArgumentError: #{ e . message } " )
end
rescue_from NoMethodError do | e |
error! ( "NoMethodError: #{ e . message } " )
end
end By default, rescue_from will rescue the exceptions listed and all their subclasses.
Assume you have the following exception classes defined.
module APIErrors
class ParentError < StandardError ; end
class ChildError < ParentError ; end
end Then the following rescue_from clause will rescue exceptions of type APIErrors::ParentError and its subclasses (in this case APIErrors::ChildError ).
rescue_from APIErrors :: ParentError do | e |
error! ( {
error : " #{ e . class } error" ,
message : e . message
} , e . status )
end To only rescue the base exception class, set rescue_subclasses: false . The code below will rescue exceptions of type RuntimeError but not its subclasses.
rescue_from RuntimeError , rescue_subclasses : false do | e |
error! ( {
status : e . status ,
message : e . message ,
errors : e . errors
} , e . status )
end Helpers are also available inside rescue_from .
class Twitter :: API < Grape :: API
format :json
helpers do
def server_error!
error! ( { error : 'Server error.' } , 500 , { 'Content-Type' => 'text/error' } )
end
end
rescue_from :all do | e |
server_error!
end
end The rescue_from handler must return a Rack::Response object, call error! , or raise an exception (either the original exception or another custom one). The exception raised in rescue_from will be handled outside Grape. For example, if you mount Grape in Rails, the exception will be handle by Rails Action Controller.
Alternately, use the with option in rescue_from to specify a method or a proc .
class Twitter :: API < Grape :: API
format :json
helpers do
def server_error!
error! ( { error : 'Server error.' } , 500 , { 'Content-Type' => 'text/error' } )
end
end
rescue_from :all , with : :server_error!
rescue_from ArgumentError , with : -> { Rack :: Response . new ( 'rescued with a method' , 400 ) }
end Inside the rescue_from block, the environment of the original controller method( .self receiver) is accessible through the #context method.
class Twitter :: API < Grape :: API
rescue_from :all do | e |
user_id = context . params [ :user_id ]
error! ( "error for #{ user_id } " )
end
end You could put rescue_from clauses inside a namespace and they will take precedence over ones defined in the root scope:
class Twitter :: API < Grape :: API
rescue_from ArgumentError do | e |
error! ( "outer" )
end
namespace :statuses do
rescue_from ArgumentError do | e |
error! ( "inner" )
end
get do
raise ArgumentError . new
end
end
end Here 'inner' will be result of handling occurred ArgumentError .
Grape::Exceptions::InvalidVersionHeader , which is raised when the version in the request header doesn't match the currently evaluated version for the endpoint, will never be rescued from a rescue_from block (even a rescue_from :all ) This is because Grape relies on Rack to catch that error and try the next versioned-route for cases where there exist identical Grape endpoints with different versions.
Any exception that is not subclass of StandardError should be rescued explicitly. Usually it is not a case for an application logic as such errors point to problems in Ruby runtime. This is following standard recommendations for exceptions handling.
Grape::API provides a logger method which by default will return an instance of the Logger class from Ruby's standard library.
To log messages from within an endpoint, you need to define a helper to make the logger available in the endpoint context.
class API < Grape :: API
helpers do
def logger
API . logger
end
end
post '/statuses' do
logger . info " #{ current_user } has statused"
end
endTo change the logger level.
class API < Grape :: API
self . logger . level = Logger :: INFO
endYou can also set your own logger.
class MyLogger
def warning ( message )
puts "this is a warning: #{ message } "
end
end
class API < Grape :: API
logger MyLogger . new
helpers do
def logger
API . logger
end
end
get '/statuses' do
logger . warning " #{ current_user } has statused"
end
endFor similar to Rails request logging try the grape_logging or grape-middleware-logger gems.
Your API can declare which content-types to support by using content_type . If you do not specify any, Grape will support XML , JSON , BINARY , and TXT content-types. The default format is :txt ; you can change this with default_format . Essentially, the two APIs below are equivalent.
class Twitter :: API < Grape :: API
# no content_type declarations, so Grape uses the defaults
end
class Twitter :: API < Grape :: API
# the following declarations are equivalent to the defaults
content_type :xml , 'application/xml'
content_type :json , 'application/json'
content_type :binary , 'application/octet-stream'
content_type :txt , 'text/plain'
default_format :txt
end If you declare any content_type whatsoever, the Grape defaults will be overridden. For example, the following API will only support the :xml and :rss content-types, but not :txt , :json , or :binary . Importantly, this means the :txt default format is not supported! So, make sure to set a new default_format .
class Twitter :: API < Grape :: API
content_type :xml , 'application/xml'
content_type :rss , 'application/xml+rss'
default_format :xml
end Serialization takes place automatically. For example, you do not have to call to_json in each JSON API endpoint implementation. The response format (and thus the automatic serialization) is determined in the following order:
format parameter in the query string, if specified.format option, if specified.Accept header.default_format option.:txt .For example, consider the following API.
class MultipleFormatAPI < Grape :: API
content_type :xml , 'application/xml'
content_type :json , 'application/json'
default_format :json
get :hello do
{ hello : 'world' }
end
endGET /hello (with an Accept: */* header) does not have an extension or a format parameter, so it will respond with JSON (the default format).GET /hello.xml has a recognized extension, so it will respond with XML.GET /hello?format=xml has a recognized format parameter, so it will respond with XML.GET /hello.xml?format=json has a recognized extension (which takes precedence over the format parameter), so it will respond with XML.GET /hello.xls (with an Accept: */* header) has an extension, but that extension is not recognized, so it will respond with JSON (the default format).GET /hello.xls with an Accept: application/xml header has an unrecognized extension, but the Accept header corresponds to a recognized format, so it will respond with XML.GET /hello.xls with an Accept: text/plain header has an unrecognized extension and an unrecognized Accept header, so it will respond with JSON (the default format). You can override this process explicitly by calling api_format in the API itself. For example, the following API will let you upload arbitrary files and return their contents as an attachment with the correct MIME type.
class Twitter :: API < Grape :: API
post 'attachment' do
filename = params [ :file ] [ :filename ]
content_type MIME :: Types . type_for ( filename ) [ 0 ] . to_s
api_format :binary # there's no formatter for :binary, data will be returned "as is"
header 'Content-Disposition' , "attachment; filename*=UTF-8'' #{ CGI . escape ( filename ) } "
params [ :file ] [ :tempfile ] . read
end
end You can have your API only respond to a single format with format . If you use this, the API will not respond to file extensions other than specified in format . For example, consider the following API.
class SingleFormatAPI < Grape :: API
format :json
get :hello do
{ hello : 'world' }
end
endGET /hello will respond with JSON.GET /hello.json will respond with JSON.GET /hello.xml , GET /hello.foobar , or any other extension will respond with an HTTP 404 error code.GET /hello?format=xml will respond with an HTTP 406 error code, because the XML format specified by the request parameter is not supported.GET /hello with an Accept: application/xml header will still respond with JSON, since it could not negotiate a recognized content-type from the headers and JSON is the effective default. The formats apply to parsing, too. The following API will only respond to the JSON content-type and will not parse any other input than application/json , application/x-www-form-urlencoded , multipart/form-data , multipart/related and multipart/mixed . All other requests will fail with an HTTP 406 error code.
class Twitter :: API < Grape :: API
format :json
end When the content-type is omitted, Grape will return a 406 error code unless default_format is specified. The following API will try to parse any data without a content-type using a JSON parser.
class Twitter :: API < Grape :: API
format :json
default_format :json
end If you combine format with rescue_from :all , errors will be rendered using the same format. If you do not want this behavior, set the default error formatter with default_error_formatter .
class Twitter :: API < Grape :: API
format :json
content_type :txt , 'text/plain'
default_error_formatter :txt
endCustom formatters for existing and additional types can be defined with a proc.
class Twitter :: API < Grape :: API
content_type :xls , 'application/vnd.ms-excel'
formatter :xls , -> ( object , env ) { object . to_xls }
endYou can also use a module or class.
module XlsFormatter
def self . call ( object , env )
object . to_xls
end
end
class Twitter :: API < Grape :: API
content_type :xls , 'application/vnd.ms-excel'
formatter :xls , XlsFormatter
endBuilt-in formatters are the following.
:json : use object's to_json when available, otherwise call MultiJson.dump:xml : use object's to_xml when available, usually via MultiXml:txt : use object's to_txt when available, otherwise to_s:serializable_hash : use object's serializable_hash when available, otherwise fallback to :json:binary : data will be returned "as is"If a body is present in a request to an API, with a Content-Type header value that is of an unsupported type a "415 Unsupported Media Type" error code will be returned by Grape.
Response statuses that indicate no content as defined by Rack here will bypass serialization and the body entity - though there should be none - will not be modified.
Grape supports JSONP via Rack::JSONP, part of the rack-contrib gem. Add rack-contrib to your Gemfile .
require 'rack/contrib'
class API < Grape :: API
use Rack :: JSONP
format :json
get '/' do
'Hello World'
end
end Grape supports CORS via Rack::CORS, part of the rack-cors gem. Add rack-cors to your Gemfile , then use the middleware in your config.ru file.
require 'rack/cors'
use Rack :: Cors do
allow do
origins '*'
resource '*' , headers : :any , methods : :get
end
end
run Twitter :: API Content-type is set by the formatter. You can override the content-type of the response at runtime by setting the Content-Type header.
class API < Grape :: API
get '/home_timeline_js' do
content_type 'application/javascript'
"var statuses = ...;"
end
end Grape accepts and parses input data sent with the POST and PUT methods as described in the Parameters section above. It also supports custom data formats. You must declare additional content-types via content_type and optionally supply a parser via parser unless a parser is already available within Grape to enable a custom format. Such a parser can be a function or a class.
With a parser, parsed data is available "as-is" in env['api.request.body'] . Without a parser, data is available "as-is" and in env['api.request.input'] .
The following example is a trivial parser that will assign any input with the "text/custom" content-type to :value . The parameter will be available via params[:value] inside the API call.
module CustomParser
def self . call ( object , env )
{ value : object . to_s }
end
end content_type :txt , 'text/plain'
content_type :custom , 'text/custom'
parser :custom , CustomParser
put 'value' do
params [ :value ]
endYou can invoke the above API as follows.
curl -X PUT -d 'data' 'http://localhost:9292/value' -H Content-Type:text/custom -v
You can disable parsing for a content-type with nil . For example, parser :json, nil will disable JSON parsing altogether. The request data is then available as-is in env['api.request.body'] .
Grape uses JSON and ActiveSupport::XmlMini for JSON and XML parsing by default. It also detects and supports multi_json and multi_xml. Adding those gems to your Gemfile and requiring them will enable them and allow you to swap the JSON and XML back-ends.
Grape supports a range of ways to present your data with some help from a generic present method, which accepts two arguments: the object to be presented and the options associated with it. The options hash may include :with , which defines the entity to expose.
Add the grape-entity gem to your Gemfile. Please refer to the grape-entity documentation for more details.
The following example exposes statuses.
module API
module Entities
class Status < Grape :: Entity
expose :user_name
expose :text , documentation : { type : 'string' , desc : 'Status update text.' }
expose :ip , if : { type : :full }
expose :user_type , :user_id , if : -> ( status , options ) { status . user . public? }
expose :digest do | status , options |
Digest :: MD5 . hexdigest ( status . txt )
end
expose :replies , using : API :: Status , as : :replies
end
end
class Statuses < Grape :: API
version 'v1'
desc 'Statuses index' do
params : API :: Entities :: Status . documentation
end
get '/statuses' do
statuses = Status . all
type = current_user . admin? ? :full : :default
present statuses , with : API :: Entities :: Status , type : type
end
end
end You can use entity documentation directly in the params block with using: Entity.documentation .
module API
class Statuses < Grape :: API
version 'v1'
desc 'Create a status'
params do
requires :all , except : [ :ip ] , using : API :: Entities :: Status . documentation . except ( :id )
end
post '/status' do
Status . create! params
end
end
endYou can present with multiple entities using an optional Symbol argument.
get '/statuses' do
statuses = Status . all . page ( 1 ) . per ( 20 )
present :total_page , 10
present :per_page , 20
present :statuses , statuses , with : API :: Entities :: Status
endThe response will be
{
total_page: 10,
per_page: 20,
statuses: []
}
In addition to separately organizing entities, it may be useful to put them as namespaced classes underneath the model they represent.
class Status
def entity
Entity . new ( self )
end
class Entity < Grape :: Entity
expose :text , :user_id
end
end If you organize your entities this way, Grape will automatically detect the Entity class and use it to present your models. In this example, if you added present Status.new to your endpoint, Grape will automatically detect that there is a Status::Entity class and use that as the representative entity. This can still be overridden by using the :with option or an explicit represents call.
You can present hash with Grape::Presenters::Presenter to keep things consistent.
get '/users' do
present { id : 10 , name : :dgz } , with : Grape :: Presenters :: Presenter
endThe response will be
{
id : 10 ,
name : 'dgz'
}It has the same result with
get '/users' do
present :id , 10
present :name , :dgz
end You can use Roar to render HAL or Collection+JSON with the help of grape-roar, which defines a custom JSON formatter and enables presenting entities with Grape's present keyword.
You can use Rabl templates with the help of the grape-rabl gem, which defines a custom Grape Rabl formatter.
You can use Active Model Serializers serializers with the help of the grape-active_model_serializers gem, which defines a custom Grape AMS formatter.
In general, use the binary format to send raw data.
class API < Grape :: API
get '/file' do
content_type 'application/octet-stream'
File . binread 'file.bin'
end
end You can set the response body explicitly with body .
class API < Grape :: API
get '/' do
content_type 'text/plain'
body 'Hello World'
# return value ignored
end
end Use body false to return 204 No Content without any data or content-type.
If you want to empty the body with an HTTP status code other than 204 No Content , you can override the status code after specifying body false as follows
class API < Grape :: API
get '/' do
body false
status 304
end
end You can also set the response to a file with sendfile . This works with the Rack::Sendfile middleware to optimally send the file through your web server software.
class API < Grape :: API
get '/' do
sendfile '/path/to/file'
end
end To stream a file in chunks use stream
class API < Grape :: API
get '/' do
stream '/path/to/file'
end
end If you want to stream non-file data use the stream method and a Stream object. This is an object that responds to each and yields for each chunk to send to the client. Each chunk will be sent as it is yielded instead of waiting for all of the content to be available.
class MyStream
def each
yield 'part 1'
yield 'part 2'
yield 'part 3'
end
end
class API < Grape :: API
get '/' do
stream MyStream . new
end
end Grape has built-in Basic authentication (the given block is executed in the context of the current Endpoint ). Authentication applies to the current namespace and any children, but not parents.
http_basic do | username , password |
# verify user's password here
# IMPORTANT: make sure you use a comparison method which isn't prone to a timing attack
end Grape can use custom Middleware for authentication. How to implement these Middleware have a look at Rack::Auth::Basic or similar implementations.
For registering a Middleware you need the following options:
label - the name for your authenticator to use it laterMiddlewareClass - the MiddlewareClass to use for authenticationoption_lookup_proc - A Proc with one Argument to lookup the options at runtime (return value is an Array as Parameter for the Middleware).Beispiel:
Grape :: Middleware :: Auth :: Strategies . add ( :my_auth , AuthMiddleware , -> ( options ) { [ options [ :realm ] ] } )
auth :my_auth , { realm : 'Test Api' } do | credentials |
# lookup the user's password here
{ 'user1' => 'password1' } [ username ]
endUse Doorkeeper, warden-oauth2 or rack-oauth2 for OAuth2 support.
You can access the controller params, headers, and helpers through the context with the #context method inside any auth middleware inherited from Grape::Middleware::Auth::Base .
Grape routes can be reflected at runtime. This can notably be useful for generating documentation.
Grape exposes arrays of API versions and compiled routes. Each route contains a prefix , version , namespace , method and params . You can add custom route settings to the route metadata with route_setting .
class TwitterAPI < Grape :: API
version 'v1'
desc 'Includes custom settings.'
route_setting :custom , key : 'value'
get do
end
endExamine the routes at runtime.
TwitterAPI :: versions # yields [ 'v1', 'v2' ]
TwitterAPI :: routes # yields an array of Grape::Route objects
TwitterAPI :: routes [ 0 ] . version # => 'v1'
TwitterAPI :: routes [ 0 ] . description # => 'Includes custom settings.'
TwitterAPI :: routes [ 0 ] . settings [ :custom ] # => { key: 'value' } Note that Route#route_xyz methods have been deprecated since 0.15.0 and removed since 2.0.1.
Please use Route#xyz instead.
Note that difference of Route#options and Route#settings .
The options can be referred from your route, it should be set by specifing key and value on verb methods such as get , post and put . The settings can also be referred from your route, but it should be set by specifing key and value on route_setting .
It's possible to retrieve the information about the current route from within an API call with route .
class MyAPI < Grape :: API
desc 'Returns a description of a parameter.'
params do
requires :id , type : Integer , desc : 'Identity.'
end
get 'params/:id' do
route . params [ params [ :id ] ] # yields the parameter description
end
end The current endpoint responding to the request is self within the API block or env['api.endpoint'] elsewhere. The endpoint has some interesting properties, such as source which gives you access to the original code block of the API implementation. This can be particularly useful for building a logger middleware.
class ApiLogger < Grape :: Middleware :: Base
def before
file = env [ 'api.endpoint' ] . source . source_location [ 0 ]
line = env [ 'api.endpoint' ] . source . source_location [ 1 ]
logger . debug "[api] #{ file } : #{ line } "
end
end Blocks can be executed before or after every API call, using before , after , before_validation and after_validation . If the API fails the after call will not be triggered, if you need code to execute for sure use the finally .
Before and after callbacks execute in the following order:
beforebefore_validationafter_validation (upon successful validation)after (upon successful validation and API call)finally (always)Steps 4, 5 and 6 only happen if validation succeeds.
If a request for a resource is made with an unsupported HTTP method (returning HTTP 405) only before callbacks will be executed. The remaining callbacks will be bypassed.
If a request for a resource is made that triggers the built-in OPTIONS handler, only before and after callbacks will be executed. The remaining callbacks will be bypassed.
For example, using a simple before block to set a header.
before do
header 'X-Robots-Tag' , 'noindex'
end You can ensure a block of code runs after every request (including failures) with finally :
finally do
# this code will run after every request (successful or failed)
endNamespaces
Callbacks apply to each API call within and below the current namespace:
class MyAPI < Grape :: API
get '/' do
"root - #{ @blah } "
end
namespace :foo do
before do
@blah = 'blah'
end
get '/' do
"root - foo - #{ @blah } "
end
namespace :bar do
get '/' do
"root - foo - bar - #{ @blah } "
end
end
end
endThe behavior is then:
GET / # 'root - '
GET /foo # 'root - foo - blah'
GET /foo/bar # 'root - foo - bar - blah' Params on a namespace (or whichever alias you are using) will also be available when using before_validation or after_validation :
class MyAPI < Grape :: API
params do
requires :blah , type : Integer
end
resource ':blah' do
after_validation do
# if we reach this point validations will have passed
@blah = declared ( params , include_missing : false ) [ :blah ]
end
get '/' do
@blah . class
end
end
endThe behavior is then:
GET /123 # 'Integer'
GET /foo # 400 error - 'blah is invalid'Versioning
When a callback is defined within a version block, it's only called for the routes defined in that block.
class Test < Grape :: API
resource :foo do
version 'v1' , :using => :path do
before do
@output ||= 'v1-'
end
get '/' do
@output += 'hello'
end
end
version 'v2' , :using => :path do
before do
@output ||= 'v2-'
end
get '/' do
@output += 'hello'
end
end
end
endThe behavior is then:
GET /foo/v1 # 'v1-hello'
GET /foo/v2 # 'v2-hello'Altering Responses
Using present in any callback allows you to add data to a response:
class MyAPI < Grape :: API
format :json
after_validation do
present :name , params [ :name ] if params [ :name ]
end
get '/greeting' do
present :greeting , 'Hello!'
end
endThe behavior is then:
GET /greeting # {"greeting":"Hello!"}
GET /greeting ? name=Alan # {"name":"Alan","greeting":"Hello!"} Instead of altering a response, you can also terminate and rewrite it from any callback using error! , including after . This will cause all subsequent steps in the process to not be called. This includes the actual api call and any callbacks
Grape by default anchors all request paths, which means that the request URL should match from start to end to match, otherwise a 404 Not Found is returned. However, this is sometimes not what you want, because it is not always known upfront what can be expected from the call. This is because Rack-mount by default anchors requests to match from the start to the end, or not at all. Rails solves this problem by using a anchor: false option in your routes. In Grape this option can be used as well when a method is defined.
For instance when your API needs to get part of an URL, for instance:
class TwitterAPI < Grape :: API
namespace :statuses do
get '/(*:status)' , anchor : false do
end
end
end This will match all paths starting with '/statuses/'. There is one caveat though: the params[:status] parameter only holds the first part of the request url. Luckily this can be circumvented by using the described above syntax for path specification and using the PATH_INFO Rack environment variable, using env['PATH_INFO'] . This will hold everything that comes after the '/statuses/' part.
You can use instance variables to pass information across the various stages of a request. An instance variable set within a before validator is accessible within the endpoint's code and can also be utilized within the rescue_from handler.
class TwitterAPI < Grape :: API
before do
@var = 1
end
get '/' do
puts @var # => 1
raise
end
rescue_from :all do
puts @var # => 1
end
endThe values of instance variables cannot be shared among various endpoints within the same API. This limitation arises due to Grape generating a new instance for each request made. Consequently, instance variables set within an endpoint during one request differ from those set during a subsequent request, as they exist within separate instances.
class TwitterAPI < Grape :: API
get '/first' do
@var = 1
puts @var # => 1
end
get '/second' do
puts @var # => nil
end
end You can make a custom middleware by using Grape::Middleware::Base . It's inherited from some grape official middlewares in fact.
For example, you can write a middleware to log application exception.
class LoggingError < Grape :: Middleware :: Base
def after
return unless @app_response && @app_response [ 0 ] == 500
env [ 'rack.logger' ] . error ( "Raised error on #{ env [ 'PATH_INFO' ] } " )
end
endYour middleware can overwrite application response as follows, except error case.
class Overwriter < Grape :: Middleware :: Base
def after
[ 200 , { 'Content-Type' => 'text/plain' } , [ 'Overwritten.' ] ]
end
end You can add your custom middleware with use , that push the middleware onto the stack, and you can also control where the middleware is inserted using insert , insert_before and insert_after .
class CustomOverwriter < Grape :: Middleware :: Base
def after
[ 200 , { 'Content-Type' => 'text/plain' } , [ @options [ :message ] ] ]
end
end
class API < Grape :: API
use Overwriter
insert_before Overwriter , CustomOverwriter , message : 'Overwritten again.'
insert 0 , CustomOverwriter , message : 'Overwrites all other middleware.'
get '/' do
end
end You can access the controller params, headers, and helpers through the context with the #context method inside any middleware inherited from Grape::Middleware::Base .
Note that when you're using Grape mounted on Rails you don't have to use Rails middleware because it's already included into your middleware stack. You only have to implement the helpers to access the specific env variable.
If you are using a custom application that is inherited from Rails::Application and need to insert a new middleware among the ones initiated via Rails, you will need to register it manually in your custom application class.
class Company :: Application < Rails :: Application
config . middleware . insert_before ( Rack :: Attack , Middleware :: ApiLogger )
end By default you can access remote IP with request.ip . This is the remote IP address implemented by Rack. Sometimes it is desirable to get the remote IP Rails-style with ActionDispatch::RemoteIp .
Add gem 'actionpack' to your Gemfile and require 'action_dispatch/middleware/remote_ip.rb' . Use the middleware in your API and expose a client_ip helper. See this documentation for additional options.
class API < Grape :: API
use ActionDispatch :: RemoteIp
helpers do
def client_ip
env [ 'action_dispatch.remote_ip' ] . to_s
end
end
get :remote_ip do
{ ip : client_ip }
end
end Use rack-test and define your API as app .
You can test a Grape API with RSpec by making HTTP requests and examining the response.
describe Twitter :: API do
include Rack :: Test :: Methods
def app
Twitter :: API
end
context 'GET /api/statuses/public_timeline' do
it 'returns an empty array of statuses' do
get '/api/statuses/public_timeline'
expect ( last_response . status ) . to eq ( 200 )
expect ( JSON . parse ( last_response . body ) ) . to eq [ ]
end
end
context 'GET /api/statuses/:id' do
it 'returns a status by id' do
status = Status . create!
get "/api/statuses/ #{ status . id } "
expect ( last_response . body ) . to eq status . to_json
end
end
endThere's no standard way of sending arrays of objects via an HTTP GET, so POST JSON data and specify the correct content-type.
describe Twitter :: API do
context 'POST /api/statuses' do
it 'creates many statuses' do
statuses = [ { text : '...' } , { text : '...' } ]
post '/api/statuses' , statuses . to_json , 'CONTENT_TYPE' => 'application/json'
expect ( last_response . body ) . to eq 201
end
end
end You can test with other RSpec-based frameworks, including Airborne, which uses rack-test to make requests.
require 'airborne'
Airborne . configure do | config |
config . rack_app = Twitter :: API
end
describe Twitter :: API do
context 'GET /api/statuses/:id' do
it 'returns a status by id' do
status = Status . create!
get "/api/statuses/ #{ status . id } "
expect_json ( status . as_json )
end
end
end require 'test_helper'
class Twitter :: APITest < MiniTest :: Test
include Rack :: Test :: Methods
def app
Twitter :: API
end
def test_get_api_statuses_public_timeline_returns_an_empty_array_of_statuses
get '/api/statuses/public_timeline'
assert last_response . ok?
assert_equal [ ] , JSON . parse ( last_response . body )
end
def test_get_api_statuses_id_returns_a_status_by_id
status = Status . create!
get "/api/statuses/ #{ status . id } "
assert_equal status . to_json , last_response . body
end
end describe Twitter :: API do
context 'GET /api/statuses/public_timeline' do
it 'returns an empty array of statuses' do
get '/api/statuses/public_timeline'
expect ( response . status ) . to eq ( 200 )
expect ( JSON . parse ( response . body ) ) . to eq [ ]
end
end
context 'GET /api/statuses/:id' do
it 'returns a status by id' do
status = Status . create!
get "/api/statuses/ #{ status . id } "
expect ( response . body ) . to eq status . to_json
end
end
end In Rails, HTTP request tests would go into the spec/requests group. You may want your API code to go into app/api - you can match that layout under spec by adding the following in spec/rails_helper.rb .
RSpec . configure do | config |
config . include RSpec :: Rails :: RequestExampleGroup , type : :request , file_path : /spec / api/
end class Twitter :: APITest < ActiveSupport :: TestCase
include Rack :: Test :: Methods
def app
Rails . application
end
test 'GET /api/statuses/public_timeline returns an empty array of statuses' do
get '/api/statuses/public_timeline'
assert last_response . ok?
assert_equal [ ] , JSON . parse ( last_response . body )
end
test 'GET /api/statuses/:id returns a status by id' do
status = Status . create!
get "/api/statuses/ #{ status . id } "
assert_equal status . to_json , last_response . body
end
end Because helpers are mixed in based on the context when an endpoint is defined, it can be difficult to stub or mock them for testing. The Grape::Endpoint.before_each method can help by allowing you to define behavior on the endpoint that will run before every request.
describe 'an endpoint that needs helpers stubbed' do
before do
Grape :: Endpoint . before_each do | endpoint |
allow ( endpoint ) . to receive ( :helper_name ) . and_return ( 'desired_value' )
end
end
after do
Grape :: Endpoint . before_each nil
end
it 'stubs the helper' do
end
end Use grape-reload.
Add API paths to config/application.rb .
# Auto-load API and its subdirectories
config . paths . add File . join ( 'app' , 'api' ) , glob : File . join ( '**' , '*.rb' )
config . autoload_paths += Dir [ Rails . root . join ( 'app' , 'api' , '*' ) ] Create config/initializers/reload_api.rb .
if Rails . env . development?
ActiveSupport :: Dependencies . explicitly_unloadable_constants << 'Twitter::API'
api_files = Dir [ Rails . root . join ( 'app' , 'api' , '**' , '*.rb' ) ]
api_reloader = ActiveSupport :: FileUpdateChecker . new ( api_files ) do
Rails . application . reload_routes!
end
ActionDispatch :: Callbacks . to_prepare do
api_reloader . execute_if_updated
end
endFor Rails >= 5.1.4, change this:
ActionDispatch :: Callbacks . to_prepare do
api_reloader . execute_if_updated
endto this:
ActiveSupport :: Reloader . to_prepare do
api_reloader . execute_if_updated
endSee StackOverflow #3282655 for more information.
Grape has built-in support for ActiveSupport::Notifications which provides simple hook points to instrument key parts of your application.
The following are currently supported:
The main execution of an endpoint, includes filters and rendering.
The execution of the main content block of the endpoint.
The execution of validators.
Serialization or template rendering.
Grape::Formatter::Json )See the ActiveSupport::Notifications documentation for information on how to subscribe to these events.
Grape integrates with following third-party tools:
Grape is work of hundreds of contributors. You're encouraged to submit pull requests, propose features and discuss issues.
See CONTRIBUTING.
See SECURITY for details.
MIT License. See LICENSE for details.
Copyright (c) 2010-2020 Michael Bleigh, Intridea Inc. and Contributors.
