grape
1.0.0
Grape adalah kerangka API seperti REST untuk Ruby. Ini dirancang untuk berjalan di rak atau melengkapi kerangka kerja aplikasi web yang ada seperti Rails dan Sinatra dengan menyediakan DSL sederhana untuk dengan mudah mengembangkan API REST. Ini memiliki dukungan bawaan untuk konvensi umum, termasuk beberapa format, pembatasan subdomain/awalan, negosiasi konten, versi dan banyak lagi.
Anda membaca dokumentasi untuk rilis anggur berikutnya, yang seharusnya 2.3.0. Rilis stabil saat ini adalah 2.2.0.
Tersedia sebagai bagian dari langganan tidelift.
Pemelihara anggur bekerja dengan Tidelift untuk memberikan dukungan dan pemeliharaan komersial. Hemat waktu, kurangi risiko, dan tingkatkan kesehatan kode, sambil membayar pengelola anggur. Klik di sini untuk lebih jelasnya.
Ruby 2.7 atau lebih baru diperlukan.
Anggur tersedia sebagai permata, untuk menginstalnya:
bundle add grape
Grape API adalah aplikasi rak yang dibuat oleh subklassing Grape::API . Di bawah ini adalah contoh sederhana yang menunjukkan beberapa fitur anggur yang lebih umum dalam konteks menciptakan kembali bagian -bagian API Twitter.
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 Deprecator Grape akan ditambahkan ke Deprecators Aplikasi Anda secara otomatis sebagai :grape , sehingga konfigurasi aplikasi Anda dapat diterapkan padanya.
Secara default Grape akan menyusun rute pada rute pertama, dimungkinkan untuk melakukan rute pra-pemuatan menggunakan compile! metode.
Twitter :: API . compile! Ini dapat ditambahkan ke config.ru Anda (jika menggunakan rackup), application.rb (jika menggunakan rel), atau file apa pun yang memuat server Anda.
Sampel di atas membuat aplikasi rak yang dapat dijalankan dari file rackup config.ru dengan rackup :
run Twitter :: API(Dengan pra-pemuatan yang dapat Anda gunakan)
Twitter :: API . compile!
run Twitter :: APIDan akan menanggapi rute berikut:
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
Grape juga akan secara otomatis menanggapi kepala dan opsi untuk semua, dan hanya opsi untuk semua rute lainnya.
Jika Anda ingin memasang anggur di samping kerangka kerja rak lain seperti Sinatra, Anda dapat melakukannya dengan mudah menggunakan Rack::Cascade :
# 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 ] Perhatikan bahwa urutan memuat aplikasi menggunakan Rack::Cascade Matters. Aplikasi anggur harus terakhir jika Anda ingin menaikkan 404 kesalahan khusus dari anggur (seperti error!('Not Found',404) ). Jika aplikasi anggur tidak terakhir dan mengembalikan respons 404 atau 405, Cascade menggunakannya sebagai sinyal untuk mencoba aplikasi berikutnya. Ini dapat menyebabkan perilaku yang tidak diinginkan menunjukkan halaman 404 yang salah dari aplikasi yang salah.
Tempatkan file API ke dalam app/api . Rails mengharapkan subdirektori yang cocok dengan nama modul Ruby dan nama file yang cocok dengan nama kelas. Dalam contoh kami, lokasi nama file dan direktori untuk Twitter::API harus berupa app/api/twitter/api.rb .
Ubah config/routes :
mount Twitter :: API => '/' Autoloader default Rails adalah Zeitwerk . Secara default, ini mengintupati api sebagai Api , bukan API . Untuk membuat contoh kami berfungsi, Anda perlu melepaskan garis di bagian bawah config/initializers/inflections.rb , dan menambahkan API sebagai akronim:
ActiveSupport :: Inflector . inflections ( :en ) do | inflect |
inflect . acronym 'API'
endAnda dapat memasang beberapa implementasi API di dalam yang lain. Ini tidak harus menjadi versi yang berbeda, tetapi mungkin komponen dari API yang sama.
class Twitter :: API < Grape :: API
mount Twitter :: APIv1
mount Twitter :: APIv2
end Anda juga dapat dipasang di jalur, yang mirip dengan menggunakan prefix di dalam API yang dipasang itu sendiri.
class Twitter :: API < Grape :: API
mount Twitter :: APIv1 => '/v1'
end Deklarasi seperti before/after/rescue_from dapat ditempatkan sebelum atau sesudah mount . Bagaimanapun mereka akan diwarisi.
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 Anda dapat memasang titik akhir yang sama di dua lokasi yang berbeda.
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 Dengan asumsi bahwa titik akhir posting dan komentar dipasang di /posts dan /comments , Anda sekarang harus dapat melakukan get /posts/votes , post /posts/votes , get /comments/votes dan post /comments/votes .
Anda dapat mengonfigurasi titik akhir yang dapat diulang untuk mengubah cara mereka berperilaku sesuai dengan tempat mereka dipasang.
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 Perhatikan bahwa jika Anda melewati hash sebagai parameter pertama yang akan mount , Anda harus secara eksplisit menempatkan () di sekitar parameter:
# good
mount ( { :: Some :: Api => '/some/api' } , with : { condition : true } )
# bad
mount :: Some :: Api => '/some/api' , with : { condition : true } Anda dapat mengakses configuration di kelas (untuk digunakan sebagai atribut dinamis), di dalam blok (seperti namespace)
Jika Anda ingin logika terjadi pada configuration , Anda dapat menggunakan penolong given .
class ConditionalEndpoint :: API < Grape :: API
given configuration [ :some_setting ] do
get 'mount_this_endpoint_conditionally' do
configuration [ :configurable_response ]
end
end
end Jika Anda ingin blok logika berjalan setiap kali titik akhir dipasang (di mana Anda dapat mengakses hash configuration )
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 Hasil yang lebih kompleks dapat dicapai dengan menggunakan mounted sebagai ekspresi di mana configuration sudah dievaluasi sebagai hash.
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 Anda memiliki opsi untuk menyediakan berbagai versi API Anda dengan membuat Grape::API untuk setiap versi yang ditawarkan dan kemudian mengintegrasikannya ke dalam kelas Grape::API . Pastikan versi yang lebih baru dipasang sebelum yang lebih tua. Pendekatan default untuk versi mengarahkan permintaan ke middleware rak berikutnya jika versi tertentu tidak ditemukan.
require 'v1'
require 'v2'
require 'v3'
class App < Grape :: API
mount V3
mount V2
mount V1
endUntuk mempertahankan titik akhir yang sama dari versi API sebelumnya tanpa menulis ulang, Anda dapat menunjukkan beberapa versi dalam versi API sebelumnya.
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
endMenggunakan contoh yang disediakan, titik akhir selanjutnya akan dapat diakses di berbagai versi:
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 Ada empat strategi di mana klien dapat mencapai titik akhir API Anda :: :path , :header , :accept_version_header dan :param . Strategi default adalah :path .
version 'v1' , using : :pathMenggunakan strategi versi ini, klien harus lulus versi yang diinginkan di URL.
curl http://localhost:9292/v1/statuses/public_timeline
version 'v1' , using : :header , vendor : 'twitter'Saat ini, Grape hanya mendukung jenis media versi dalam format berikut:
vnd.vendor-and-or-resource-v1234+format
Pada dasarnya semua token antara final - dan + akan ditafsirkan sebagai versi.
Menggunakan strategi versi ini, klien harus lulus versi yang diinginkan di http Accept kepala.
curl -H Accept:application/vnd.twitter-v1+json http://localhost:9292/statuses/public_timeline
Secara default, versi pencocokan pertama digunakan ketika tidak ada header Accept disediakan. Perilaku ini mirip dengan perutean di rel. Untuk menghindari perilaku default ini, seseorang dapat menggunakan :strict . Ketika opsi ini diatur ke true , 406 Not Acceptable dikembalikan ketika tidak ada header Accept yang benar disediakan.
Ketika header Accept yang tidak valid disediakan, 406 Not Acceptable dikembalikan jika opsi :cascade diatur ke false . Kalau tidak, kesalahan 404 Not Found dikembalikan oleh rak jika tidak ada rute lain yang cocok.
Anggur akan mengevaluasi preferensi kualitas relatif yang termasuk dalam header menerima dan default ke kualitas 1.0 saat dihilangkan. Dalam contoh berikut, API anggur yang mendukung XML dan JSON dalam urutan itu akan mengembalikan JSON:
curl -H "Accept: text/xml;q=0.8, application/json;q=0.9" localhost:1234/resource
version 'v1' , using : :accept_version_header Menggunakan strategi versi ini, klien harus lulus versi yang diinginkan di header Accept-Version HTTP.
curl -H "Accept-Version:v1" http://localhost:9292/statuses/public_timeline
Secara default, versi pencocokan pertama digunakan ketika tidak ada header Accept-Version disediakan. Perilaku ini mirip dengan perutean di rel. Untuk menghindari perilaku default ini, seseorang dapat menggunakan :strict . Ketika opsi ini diatur ke true , kesalahan 406 Not Acceptable dikembalikan ketika tidak ada header Accept yang benar disediakan dan opsi :cascade diatur ke false . Kalau tidak, kesalahan 404 Not Found dikembalikan oleh rak jika tidak ada rute lain yang cocok.
version 'v1' , using : :paramDengan menggunakan strategi versi ini, klien harus lulus versi yang diinginkan sebagai parameter permintaan, baik di string kueri URL atau di badan permintaan.
curl http://localhost:9292/statuses/public_timeline?apiver=v1
Nama default untuk parameter kueri adalah 'APIVER' tetapi dapat ditentukan menggunakan opsi :parameter .
version 'v1' , using : :param , parameter : 'v' curl http://localhost:9292/statuses/public_timeline?v=v1
Anda dapat menambahkan deskripsi ke metode API dan ruang nama. Deskripsi akan digunakan oleh appragger anggur untuk menghasilkan dokumentasi yang sesuai dengan Swagger.
Catatan: Blok deskripsi hanya untuk dokumentasi dan tidak akan mempengaruhi perilaku API.
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 : deskripsi yang lebih ditingkatkanparams : Tentukan parameter langsung dari suatu Entitysuccess : (Mantan entitas) Entity yang akan digunakan untuk menyajikan respons keberhasilan untuk rute ini.failure : (bekas http_codes) Definisi dari kegagalan yang digunakan kode dan entitas http.default : Definisi dan Entity yang digunakan untuk menyajikan respons default untuk rute ini.named : Seorang penolong untuk memberikan nama rute dan menemukannya dengan nama ini di hash dokumentasiheaders : Definisi header yang digunakan Gunakan Grape.configure untuk mengatur pengaturan global pada waktu pemuatan. Saat ini pengaturan yang dapat dikonfigurasi adalah:
param_builder : Mengatur pembangun parameter, default ke Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder .Untuk mengubah nilai pengaturan, pastikan bahwa pada titik tertentu selama waktu pemuatan kode berikut berjalan
Grape . configure do | config |
config . setting = value
end Misalnya, untuk param_builder , kode berikut dapat berjalan dalam inisialisasi:
Grape . configure do | config |
config . param_builder = Grape :: Extensions :: Hashie :: Mash :: ParamBuilder
endAnda juga dapat mengkonfigurasi API tunggal:
API . configure do | config |
config [ key ] = value
end Ini akan tersedia di dalam API dengan configuration , seolah -olah itu adalah konfigurasi pemasangan.
Parameter permintaan tersedia melalui objek hash params . Ini termasuk parameter GET , POST dan PUT , bersama dengan parameter bernama yang Anda tentukan dalam string rute Anda.
get :public_timeline do
Status . order ( params [ :sort_by ] )
end Parameter secara otomatis diisi dari badan permintaan di POST dan PUT untuk input formulir, JSON dan jenis konten XML.
Permintaan:
curl -d '{"text": "140 characters"}' 'http://localhost:9292/statuses' -H Content-Type:application/json -v
Titik akhir anggur:
post '/statuses' do
Status . create! ( text : params [ :text ] )
endPosting dan put multipar juga didukung.
Permintaan:
curl --form image_file='@image.jpg;type=image/jpg' http://localhost:9292/upload
Titik akhir anggur:
post 'upload' do
# file in params[:image_file]
endDalam hal konflik antara salah satu dari:
GET , POST dan PUT parameterPOST dan PUTParameter string rute akan diutamakan.
Parameter default tersedia sebagai ActiveSupport::HashWithIndifferentAccess . Ini dapat diubah menjadi, misalnya, ruby Hash atau Hashie::Mash untuk seluruh API.
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 Kelas juga dapat diganti pada blok parameter individual menggunakan build_with sebagai berikut.
params do
build_with Grape :: Extensions :: Hash :: ParamBuilder
optional :color , type : String
end Atau secara global dengan konfigurasi Grape.configure.param_builder .
Dalam contoh di atas, params["color"] akan mengembalikan nil karena params adalah Hash biasa.
Pembangun parameter yang tersedia adalah Grape::Extensions::Hash::ParamBuilder , Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder dan Grape::Extensions::Hashie::Mash::ParamBuilder .
Grape memungkinkan Anda untuk hanya mengakses parameter yang telah dinyatakan oleh Blok params Anda. Itu akan:
Pertimbangkan titik akhir API berikut:
format :json
post 'users/signup' do
{ 'declared_params' => declared ( params ) }
end Jika Anda tidak menentukan parameter apa pun, declared akan mengembalikan hash kosong.
Meminta
curl -X POST -H " Content-Type: application/json " localhost:9292/users/signup -d ' {"user": {"first_name":"first name", "last_name": "last name"}} 'Tanggapan
{
"declared_params" : {}
}
Setelah kami menambahkan persyaratan parameter, anggur akan mulai mengembalikan hanya parameter yang dinyatakan.
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 ) }
endMeminta
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"}} 'Tanggapan
{
"declared_params" : {
"user" : {
"first_name" : " first name " ,
"last_name" : " last name "
}
}
} Param yang hilang yang dinyatakan sebagai tipe Hash atau Array akan dimasukkan.
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 ) }
endMeminta
curl -X POST -H " Content-Type: application/json " localhost:9292/users/signup -d ' {} 'Tanggapan
{
"declared_params" : {
"user" : {
"first_name" : null ,
"last_name" : null
},
"widgets" : []
}
} Hash yang dikembalikan adalah ActiveSupport::HashWithIndifferentAccess .
Metode #declared tidak tersedia untuk filter before , seperti yang dievaluasi sebelum paksaan parameter.
Secara default declared(params) mencakup parameter yang didefinisikan dalam semua ruang nama induk. Jika Anda hanya ingin mengembalikan parameter dari namespace Anda saat ini, Anda dapat mengatur opsi include_parent_namespaces ke false .
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
endMeminta
curl -X GET -H " Content-Type: application/json " localhost:9292/parent/foo/barTanggapan
{
"without_parent_namespaces" : {
"child_name" : " bar "
},
"with_parent_namespaces" : {
"parent_name" : " foo " ,
"child_name" : " bar "
},
} Secara default declared(params) termasuk parameter yang memiliki nilai nil . Jika Anda hanya ingin mengembalikan parameter yang bukan nil , Anda dapat menggunakan opsi include_missing . Secara default, include_missing diatur ke true . Pertimbangkan API berikut:
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 ) }
endMeminta
curl -X POST -H " Content-Type: application/json " localhost:9292/users/signup -d ' {"user": {"first_name":"first name", "random": "never shown"}} 'Respons dengan include_missing: false
{
"declared_params" : {
"user" : {
"first_name" : " first name "
}
}
}Respons dengan include_missing: true
{
"declared_params" : {
"user" : {
"first_name" : " first name " ,
"last_name" : null
}
}
}Ini juga bekerja pada hash bersarang:
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 ) }
endMeminta
curl -X POST -H " Content-Type: application/json " localhost:9292/users/signup -d ' {"user": {"first_name":"first name", "random": "never shown", "address": { "city": "SF"}}} 'Respons dengan include_missing: false
{
"declared_params" : {
"user" : {
"first_name" : " first name " ,
"address" : {
"city" : " SF "
}
}
}
}Respons dengan include_missing: true
{
"declared_params" : {
"user" : {
"first_name" : " first name " ,
"last_name" : null ,
"address" : {
"city" : " Zurich " ,
"region" : null
}
}
}
} Perhatikan bahwa atribut dengan nilai nil tidak dianggap hilang dan juga akan dikembalikan ketika include_missing diatur ke false :
Meminta
curl -X POST -H " Content-Type: application/json " localhost:9292/users/signup -d ' {"user": {"first_name":"first name", "last_name": null, "address": { "city": "SF"}}} 'Respons dengan include_missing: false
{
"declared_params" : {
"user" : {
"first_name" : " first name " ,
"last_name" : null ,
"address" : { "city" : " SF " }
}
}
} Secara default declared(params) tidak akan given dan mengembalikan semua parameter. Gunakan evaluate_given untuk mengevaluasi semua blok given dan hanya mengembalikan parameter yang memenuhi kondisi given . Pertimbangkan API berikut:
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 ) }
endMeminta
curl -X POST -H " Content-Type: application/json " localhost:9292/child -d ' {"father_id": 1} 'Respons dengan evalute_given: false
{
"declared_params" : {
"child_id" : null ,
"father_id" : 1
}
}Respons dengan evaluasi_given: Benar
{
"declared_params" : {
"child_id" : null
}
}Ini juga bekerja pada hash bersarang:
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 ) }
endMeminta
curl -X POST -H " Content-Type: application/json " localhost:9292/child -d ' {"child": {"father_id": 1}} 'Respons dengan evalute_given: false
{
"declared_params" : {
"child" : {
"child_id" : null ,
"father_id" : 1
}
}
}Respons dengan evaluasi_given: Benar
{
"declared_params" : {
"child" : {
"child_id" : null
}
}
} Menggunakan route_param lebih diutamakan daripada parameter reguler yang ditentukan dengan nama yang sama:
params do
requires :foo , type : String
end
route_param :foo do
get do
{ value : params [ :foo ] }
end
endMeminta
curl -X POST -H " Content-Type: application/json " localhost:9292/bar -d ' {"foo": "baz"} 'Tanggapan
{
"value" : " bar "
} Anda dapat mendefinisikan validasi dan opsi paksaan untuk parameter Anda menggunakan blok params .
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
endKetika tipe ditentukan, validasi implisit dilakukan setelah paksaan untuk memastikan jenis output yang dinyatakan.
Parameter opsional dapat memiliki nilai default.
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 Nilai default dievaluasi dengan penuh semangat. Atas :non_random_number akan mengevaluasi ke nomor yang sama untuk setiap panggilan ke titik akhir blok params ini. Agar default mengevaluasi dengan malas dengan setiap permintaan, gunakan lambda, seperti :random_number di atas.
Perhatikan bahwa nilai default akan diteruskan ke opsi validasi yang ditentukan. Contoh berikut akan selalu gagal jika :color tidak disediakan secara eksplisit.
params do
optional :color , type : String , default : 'blue' , values : [ 'red' , 'green' ]
endImplementasi yang benar adalah memastikan nilai default melewati semua validasi.
params do
optional :color , type : String , default : 'blue' , values : [ 'blue' , 'red' , 'green' ]
end Anda dapat menggunakan nilai satu parameter sebagai nilai default dari beberapa parameter lainnya. Dalam hal ini, jika parameter primary_color tidak disediakan, ia akan memiliki nilai yang sama dengan color . Jika keduanya tidak disediakan, keduanya akan memiliki nilai blue .
params do
optional :color , type : String , default : 'blue'
optional :primary_color , type : String , default : -> ( params ) { params [ :color ] }
endBerikut ini adalah semua tipe yang valid, didukung di luar kotak dengan anggur:
File alias)Perlu diketahui bahwa perilaku itu berbeda antara Ruby 2.4 dan versi sebelumnya. Di Ruby 2.4, nilai yang terdiri dari angka dikonversi ke integer, tetapi dalam versi sebelumnya akan diperlakukan sebagai fixnum.
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 Selain dari set default jenis yang didukung yang tercantum di atas, kelas apa pun dapat digunakan sebagai jenis selama metode paksaan eksplisit disediakan. Jika tipe mengimplementasikan metode parse tingkat kelas, anggur akan menggunakannya secara otomatis. Metode ini harus mengambil satu argumen string dan mengembalikan instance dari jenis yang benar, atau mengembalikan instance Grape::Types::InvalidValue yang secara opsional menerima pesan untuk dikembalikan dalam respons.
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 Atau, metode paksaan khusus dapat disuplai untuk semua jenis parameter menggunakan coerce_with . Kelas atau objek apa pun dapat diberikan yang mengimplementasikan metode parse atau call , dalam urutan prioritas. Metode harus menerima parameter string tunggal, dan nilai pengembalian harus cocok dengan type yang diberikan.
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 Perhatikan bahwa, nilai nil akan memanggil metode paksaan khusus, sedangkan parameter yang hilang tidak akan.
Contoh Penggunaan coerce_with dengan lambda (kelas dengan metode parse juga bisa digunakan) itu akan mengurai string dan mengembalikan array bilangan bulat, mencocokkan type Array[Integer] .
params do
requires :values , type : Array [ Integer ] , coerce_with : -> ( val ) { val . split ( / s +/ ) . map ( & :to_i ) }
end Grape akan menegaskan bahwa nilai yang dipaksa cocok dengan type yang diberikan, dan akan menolak permintaan jika tidak. Untuk mengesampingkan perilaku ini, tipe khusus dapat mengimplementasikan parsed? Metode yang harus menerima argumen tunggal dan mengembalikan true jika nilai melewati validasi tipe.
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 Grape memanfaatkan Rack::Request untuk parameter file multipart. Parameter seperti itu dapat dinyatakan dengan type: File :
params do
requires :avatar , type : File
end
post '/' do
params [ :avatar ] [ :filename ] # => 'avatar.png'
params [ :avatar ] [ :type ] # => 'image/png'
params [ :avatar ] [ :tempfile ] # => #<File>
endJSON kelas satu Grape mendukung parameter kompleks yang diberikan sebagai string yang diformat JSON menggunakan type: JSON . Objek dan array objek JSON diterima secara setara, dengan aturan validasi bersarang diterapkan pada semua objek dalam kedua kasus:
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 Selain itu, type: Array[JSON] dapat digunakan, yang secara eksplisit menandai parameter sebagai array objek. Jika satu objek disediakan itu akan dibungkus.
params do
requires :json , type : Array [ JSON ] do
requires :int , type : Integer
end
end
get '/' do
params [ :json ] . each { | obj | ... } # always works
end Untuk kontrol yang lebih ketat atas jenis struktur JSON yang dapat disediakan, Gunakan type: Array, coerce_with: JSON atau type: Hash, coerce_with: JSON .
Parameter tipe varian dapat dinyatakan menggunakan opsi types daripada 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"] Sebagai kasus khusus, koleksi tipe varian-anggota juga dapat dinyatakan, dengan melewati Set atau Array dengan lebih dari satu anggota untuk 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 dapat bersarang menggunakan group atau dengan menelepon requires atau optional dengan blok. Dalam contoh di atas, ini berarti params[:media][:url] diperlukan bersama dengan params[:id] , dan params[:audio][:format] Diperlukan hanya jika params[:audio] ada. Dengan blok, group , requires dan optional menerima type opsi tambahan yang dapat berupa Array atau Hash , dan default untuk Array . Bergantung pada nilainya, parameter bersarang akan diperlakukan baik sebagai nilai hash atau sebagai nilai hash dalam array.
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 Misalkan beberapa parameter Anda hanya relevan jika parameter lain diberikan; Grape memungkinkan Anda untuk mengekspresikan hubungan ini melalui metode given di blok parameter Anda, seperti itu:
params do
optional :shelf_id , type : Integer
given :shelf_id do
requires :bin_id , type : Integer
end
end Dalam contoh di atas anggur akan menggunakan blank? Untuk memeriksa apakah Param shelf_id hadir.
given juga mengambil Proc dengan kode khusus. Di bawah ini, description param hanya diperlukan jika nilai category sama dengan foo :
params do
optional :category
given category : -> ( val ) { val == 'foo' } do
requires :description
end
endAnda dapat mengganti nama parameter:
params do
optional :category , as : :type
given type : -> ( val ) { val == 'foo' } do
requires :description
end
end CATATAN: Param in given haruslah yang diganti namanya. Dalam contoh, itu harus type , bukan category .
Opsi parameter dapat dikelompokkan. Ini dapat bermanfaat jika Anda ingin mengekstraksi validasi atau jenis umum untuk beberapa parameter. Dalam kelompok-kelompok ini, parameter individu dapat memperluas atau secara selektif mengganti pengaturan umum, memungkinkan Anda untuk mempertahankan default pada tingkat grup sambil tetap menerapkan aturan khusus parameter jika diperlukan.
Contoh di bawah ini menyajikan kasus khas ketika parameter berbagi opsi umum.
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 Grape memungkinkan Anda untuk menyajikan logika yang sama melalui metode with blok parameter Anda, seperti itu:
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
endAnda dapat mengatur pengaturan menjadi lapisan menggunakan blok bersarang `dengan '. Setiap lapisan dapat menggunakan, menambah, atau mengubah pengaturan lapisan di atasnya. Ini membantu menjaga parameter yang kompleks terorganisir dan konsisten, sambil tetap memungkinkan kustomisasi tertentu dibuat.
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 Anda dapat mengganti nama parameter menggunakan as , yang dapat berguna saat refactoring API yang ada:
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 Nilai yang diteruskan ke as akan menjadi kunci saat memanggil declared(params) .
allow_blank Parameter dapat didefinisikan sebagai allow_blank , memastikan bahwa mereka berisi nilai. Secara default, hanya requires memvalidasi bahwa parameter dikirim dalam permintaan, terlepas dari nilainya. Dengan allow_blank: false , Nilai Kosong atau Nilai Whitespace hanya tidak valid.
allow_blank dapat dikombinasikan dengan keduanya requires dan optional . Jika parameter diperlukan, ia harus berisi nilai. Jika opsional, mungkin untuk tidak mengirimkannya dalam permintaan, tetapi jika itu dikirim, ia harus memiliki beberapa nilai, dan bukan string kosong/hanya Whitespace.
params do
requires :username , allow_blank : false
optional :first_name , allow_blank : false
end values Parameter dapat dibatasi pada set nilai tertentu dengan opsi :values .
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 Menyediakan rentang ke opsi :values memastikan bahwa parameternya (atau parameter) termasuk dalam rentang tersebut (menggunakan 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'
endCatatan rentang yang tak ada habisnya juga didukung dengan ActiveSupport> = 6.0, tetapi mereka mensyaratkan jenis yang disediakan.
params do
requires :minimum , type : Integer , values : 10 ..
optional :maximum , type : Integer , values : .. 10
end Perhatikan bahwa kedua titik akhir rentang harus menjadi #kind_of? Opsi :type Anda (jika Anda tidak menyediakan opsi :type , itu akan ditebak sama dengan kelas titik akhir pertama rentang). Jadi berikut ini tidak valid:
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 Opsi :values juga dapat dilengkapi dengan Proc , dievaluasi malas dengan setiap permintaan. Jika proc memiliki arity nol (yaitu tidak perlu argumen) diharapkan untuk mengembalikan daftar atau rentang yang kemudian akan digunakan untuk memvalidasi parameter.
Misalnya, dengan model status Anda mungkin ingin membatasi dengan tagar yang sebelumnya Anda tentukan dalam model HashTag .
params do
requires :hashtag , type : String , values : -> { Hashtag . all . map ( & :tag ) }
endAtau, proc dengan arity (yaitu mengambil satu argumen) dapat digunakan untuk secara eksplisit memvalidasi setiap nilai parameter. Dalam hal ini, proc diharapkan mengembalikan nilai kebenaran jika nilai parameter valid. Parameter akan dianggap tidak valid jika ProC mengembalikan nilai palsu atau jika meningkatkan standar.
params do
requires :number , type : Integer , values : -> ( v ) { v . even? && v < 25 }
endSementara procs nyaman untuk kasus tunggal, pertimbangkan untuk menggunakan validator khusus dalam kasus di mana validasi digunakan lebih dari sekali.
Perhatikan bahwa validator izin_blank berlaku saat menggunakan :values . Dalam contoh berikut tidak adanya :allow_blank tidak mencegah :state dari menerima nilai kosong karena :allow_blank default ke true .
params do
requires :state , type : Symbol , values : [ :active , :inactive ]
end except_values Parameter dapat dibatasi dari memiliki set nilai spesifik dengan opsi :except_values .
Validator except_values berperilaku serupa dengan validator values karena menerima array, rentang, atau proc. Berbeda dengan validator values , except_values hanya menerima procs dengan 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 Opsi same_as dapat diberikan untuk memastikan bahwa nilai parameter cocok.
params do
requires :password
requires :password_confirmation , same_as : :password
end length Parameter dengan jenis yang mendukung metode #length dapat dibatasi untuk memiliki panjang spesifik dengan opsi :length .
Validator menerima :min atau :max atau kedua opsi atau hanya :is untuk memvalidasi bahwa nilai parameter berada dalam batas yang diberikan.
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 dapat dibatasi agar sesuai dengan ekspresi reguler tertentu dengan opsi :regexp . Jika nilainya tidak cocok dengan ekspresi reguler, kesalahan akan dikembalikan. Perhatikan bahwa ini berlaku untuk parameter requires dan optional .
params do
requires :email , regexp : /.+@.+/
end Validator akan lulus jika parameter dikirim tanpa nilai. Untuk memastikan bahwa parameter berisi nilai, gunakan allow_blank: false .
params do
requires :email , allow_blank : false , regexp : /.+@.+/
end mutually_exclusive Parameter dapat didefinisikan sebagai mutually_exclusive , memastikan bahwa mereka tidak hadir pada saat yang sama dalam permintaan.
params do
optional :beer
optional :wine
mutually_exclusive :beer , :wine
endBeberapa set dapat didefinisikan:
params do
optional :beer
optional :wine
mutually_exclusive :beer , :wine
optional :scotch
optional :aquavit
mutually_exclusive :scotch , :aquavit
endPeringatan : Jangan pernah mendefinisikan set yang saling eksklusif dengan param yang diperlukan. Dua params yang dibutuhkan saling eksklusif akan berarti params tidak pernah valid, sehingga membuat titik akhir tidak berguna. Satu param yang diperlukan saling eksklusif dengan param opsional akan berarti yang terakhir tidak pernah valid.
exactly_one_ofParameter dapat didefinisikan sebagai 'tepatnya_one_of', memastikan bahwa persis satu parameter dipilih.
params do
optional :beer
optional :wine
exactly_one_of :beer , :wine
end Perhatikan bahwa menggunakan :default dengan mutually_exclusive akan menyebabkan banyak parameter untuk selalu memiliki nilai default dan menaikkan Grape::Exceptions::Validation pengecualian yang saling eksklusif.
at_least_one_ofParameter dapat didefinisikan sebagai 'at_least_one_of', memastikan bahwa setidaknya satu parameter dipilih.
params do
optional :beer
optional :wine
optional :juice
at_least_one_of :beer , :wine , :juice
end all_or_none_ofParameter dapat didefinisikan sebagai 'all_or_none_of', memastikan bahwa semua atau tidak ada parameter yang dipilih.
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_ofSemua metode ini dapat digunakan pada tingkat bersarang apa pun.
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 memungkinkan definisi parameter dan berlaku untuk setiap metode dalam 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 Metode namespace memiliki sejumlah alias, termasuk: group , resource , resources , dan segment . Gunakan mana pun yang membaca yang terbaik untuk API Anda.
Anda dapat dengan mudah mendefinisikan parameter rute sebagai namespace menggunakan route_param .
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 Anda juga dapat menentukan jenis parameter rute dengan meneruskan ke opsi route_param .
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
endAnda juga dapat membuat kelas khusus yang mengambil parameter.
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
endAnda juga dapat membuat validasi khusus yang menggunakan permintaan untuk memvalidasi atribut. Misalnya jika Anda ingin memiliki parameter yang hanya tersedia untuk admin, Anda dapat melakukan hal berikut.
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
endDan menggunakannya dalam definisi titik akhir Anda sebagai:
params do
optional :admin_field , type : String , admin : true
optional :non_admin_field , type : String
optional :admin_false_field , type : String , admin : false
endSetiap validasi akan memiliki instance sendiri dari validator, yang berarti bahwa validator dapat memiliki keadaan.
Kesalahan validasi dan paksaan dikumpulkan dan pengecualian tipe Grape::Exceptions::ValidationErrors diajukan. Jika pengecualian tidak dibawa, itu akan merespons dengan status 400 dan pesan kesalahan. Kesalahan validasi dikelompokkan berdasarkan nama parameter dan dapat diakses melalui Grape::Exceptions::ValidationErrors#errors .
Respons default dari Grape::Exceptions::ValidationErrors adalah string yang dapat dibaca secara manusiawi, seperti "bir, anggur saling eksklusif", dalam contoh berikut.
params do
optional :beer
optional :wine
optional :juice
exactly_one_of :beer , :wine , :juice
end Anda dapat menyelamatkan Grape::Exceptions::ValidationErrors dan merespons dengan respons khusus atau mengubah respons menjadi JSON yang diformat dengan baik untuk API JSON yang memisahkan parameter individu dan pesan kesalahan yang sesuai. Contoh rescue_from berikut menghasilkan [{"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 Mengembalikan pesan validasi sebagai array. Grape::Exceptions::ValidationErrors#message bergabung dengan pesan ke satu string.
Untuk menanggapi dengan array pesan validasi, Anda dapat menggunakan Grape::Exceptions::ValidationErrors#full_messages .
format :json
subject . rescue_from Grape :: Exceptions :: ValidationErrors do | e |
error! ( { messages : e . full_messages } , 400 )
end Grape mengembalikan semua kesalahan validasi dan paksaan yang ditemukan secara default. Untuk melewatkan semua pemeriksaan validasi berikutnya ketika param tertentu ditemukan tidak valid, gunakan fail_fast: true .
Contoh berikut tidak akan memeriksa apakah ada :wine hadir kecuali ia menemukan :beer .
params do
required :beer , fail_fast : true
required :wine
end Hasil Params kosong adalah satu Grape::Exceptions::ValidationErrors error.
Demikian pula, tidak ada tes ekspresi reguler yang akan dilakukan jika :blah kosong dalam contoh berikut.
params do
required :blah , allow_blank : false , regexp : /blah/ , fail_fast : true
endGrape mendukung I18N untuk pesan kesalahan terkait parameter, tetapi akan mundur ke bahasa Inggris jika terjemahan untuk lokal default belum disediakan. Lihat en.yml untuk kunci pesan.
Jika aplikasi Anda hanya memberlakukan lokal yang tersedia dan: en tidak termasuk dalam lokal yang tersedia, anggur tidak dapat kembali ke bahasa Inggris dan akan mengembalikan kunci terjemahan untuk pesan kesalahan. Untuk menghindari perilaku ini, berikan terjemahan untuk lokal default Anda atau tambahkan: en ke lokal yang tersedia.
Grape mendukung pesan validasi khusus untuk pesan kesalahan yang terkait dengan parameter dan terkait paksa.
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 translationsAnda dapat melewati simbol jika Anda menginginkan terjemahan I18n untuk pesan validasi khusus Anda.
params do
requires :name , message : :name_required
end # en.yml
en :
grape :
errors :
format : ! '%{attributes} %{message}'
messages :
name_required : 'must be present' Anda juga dapat mengganti nama atribut.
# en.yml
en :
grape :
errors :
format : ! '%{attributes} %{message}'
messages :
name_required : 'must be present'
attributes :
name : 'Oops! Name'Akan menghasilkan 'oops! Nama harus ada '
Anda tidak dapat mengatur opsi pesan khusus untuk default karena memerlukan interpolasi %{option1}: %{value1} is incompatible with %{option2}: %{value2} . Anda dapat mengubah pesan kesalahan default untuk default dengan mengubah tombol pesan incompatible_option_values di dalam en.yml
params do
requires :name , values : { value : -> { ( 1 .. 10 ) . to_a } , message : 'not in range from 1 to 10' } , default : 5
enddry-validation atau dry-schema Sebagai alternatif dari params DSL yang dijelaskan di atas, Anda dapat menggunakan skema atau kontrak dry-validation untuk menggambarkan parameter titik akhir. Ini bisa sangat berguna jika Anda sudah menggunakan di atas di beberapa bagian lain dari aplikasi Anda. Jika tidak, Anda harus menambahkan dry-validation atau dry-schema ke Gemfile Anda.
Kemudian hubungi contract dengan kontrak atau skema yang ditentukan sebelumnya:
CreateOrdersSchema = Dry :: Schema . Params do
required ( :orders ) . array ( :hash ) do
required ( :name ) . filled ( :string )
optional ( :volume ) . maybe ( :integer , lt? : 9 )
end
end
# ...
contract CreateOrdersSchemaAtau dengan blok, menggunakan sintaks definisi skema:
contract do
required ( :orders ) . array ( :hash ) do
required ( :name ) . filled ( :string )
optional ( :volume ) . maybe ( :integer , lt? : 9 )
end
end Yang terakhir akan mendefinisikan skema poercing ( Dry::Schema.Params ). Saat menggunakan pendekatan sebelumnya, terserah Anda untuk memutuskan apakah input akan memerlukan paksa.
Deklarasi params dan contract juga dapat digunakan bersama dalam API yang sama, misalnya untuk menggambarkan berbagai bagian namespace bersarang untuk titik akhir.
Header permintaan tersedia melalui headers helper atau dari env dalam bentuk aslinya.
get do
error! ( 'Unauthorized' , 401 ) unless headers [ 'Secret-Password' ] == 'swordfish'
end get do
error! ( 'Unauthorized' , 401 ) unless env [ 'HTTP_SECRET_PASSWORD' ] == 'swordfish'
end Contoh di atas mungkin telah diminta sebagai berikut:
curl -H " secret_PassWord: swordfish " ...Nama header akan dinormalisasi untuk Anda.
header nama helper akan dipaksa menjadi casing kebab downcased sebagai secret-password jika menggunakan rak 3.header nama helper akan dipaksa menjadi kasus kebab yang dikapitalisasi sebagai Secret-PassWord jika menggunakan rak <3.env mereka muncul di semua huruf besar, dalam case ular, dan diawali dengan 'http_' sebagai HTTP_SECRET_PASSWORDNama header akan dinormalisasi per standar HTTP yang ditentukan dalam RFC2616 Bagian 4.2 terlepas dari apa yang dikirim oleh klien.
Anda dapat mengatur header respons dengan header di dalam API.
header 'X-Robots-Tag' , 'noindex' Saat menaikkan error! , lulus header tambahan sebagai argumen. Header tambahan akan digabungkan dengan header yang ditetapkan sebelum error! panggilan.
error! 'Unauthorized' , 401 , 'X-Error-Detail' => 'Invalid token.' Untuk mendefinisikan rute, Anda dapat menggunakan metode route atau steno untuk kata kerja HTTP. Untuk mendefinisikan rute yang menerima rute yang ditetapkan ke :any . Bagian dari jalan yang dilambangkan dengan usus besar akan ditafsirkan sebagai parameter rute.
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 Untuk mendeklarasikan namespace yang awalan semua rute di dalamnya, gunakan metode namespace . group , resource , resources dan segment adalah alias untuk metode ini. Setiap titik akhir di dalam akan membagikan konteks induknya serta konfigurasi yang dilakukan dalam konteks namespace.
Metode route_param adalah metode yang nyaman untuk mendefinisikan segmen rute parameter. Jika Anda mendefinisikan jenis, itu akan menambahkan validasi untuk parameter ini.
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
endSecara opsional, Anda dapat menentukan persyaratan untuk parameter rute bernama Anda menggunakan ekspresi reguler di namespace atau titik akhir. Rute hanya cocok jika semua persyaratan dipenuhi.
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 Anda dapat mendefinisikan metode pembantu yang dapat digunakan titik akhir Anda dengan helpers makro dengan memberikan blok atau serangkaian modul.
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 Anda dapat mendefinisikan params yang dapat digunakan kembali menggunakan helpers .
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 Anda juga dapat mendefinisikan params yang dapat digunakan kembali menggunakan pembantu bersama.
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 Pembantu mendukung blok yang dapat membantu mengatur nilai default. API berikut dapat mengembalikan koleksi yang diurutkan berdasarkan id atau created_at dalam pesanan asc atau desc .
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 Jika Anda memerlukan metode untuk menghasilkan jalur di dalam titik akhir Anda, silakan lihat permata penggali anggur.
Anda dapat melampirkan dokumentasi tambahan ke params menggunakan hash documentation .
params do
optional :first_name , type : String , documentation : { example : 'Jim' }
requires :last_name , type : String , documentation : { example : 'Smith' }
endJika dokumentasi tidak diperlukan (misalnya, itu adalah API internal), dokumentasi dapat dinonaktifkan.
class API < Grape :: API
do_not_document!
# endpoints...
endDalam hal ini, anggur tidak akan membuat objek yang terkait dengan dokumentasi yang disimpan dalam RAM selamanya.
Anda dapat mengatur, mendapatkan, dan menghapus cookie Anda dengan sangat mudah menggunakan metode cookies .
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
endGunakan sintaks berbasis hash untuk mengatur lebih dari satu nilai.
cookies [ :status_count ] = {
value : 0 ,
expires : Time . tomorrow ,
domain : '.twitter.com' ,
path : '/'
}
cookies [ :status_count ] [ :value ] += 1 Hapus cookie dengan delete .
cookies . delete :status_countTentukan jalur opsional.
cookies . delete :status_count , path : '/' Secara default Grape Returns 201 untuk POST -Permintaan, 204 untuk DELETE -ripests yang tidak mengembalikan konten apa pun, dan 200 kode status untuk semua permintaan lainnya. You can use status to query and set the actual HTTP Status Code
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! panggilan.
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).Contoh:
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.
