grape
1.0.0
Grape é uma estrutura de API em forma de descanso para o Ruby. Ele foi projetado para executar no rack ou complementar as estruturas de aplicativos da web existentes, como Rails e Sinatra, fornecendo uma DSL simples para desenvolver facilmente APIs RESTful. Possui suporte interno para convenções comuns, incluindo vários formatos, restrição de subdomínio/prefixo, negociação de conteúdo, versão e muito mais.
Você está lendo a documentação para o próximo lançamento do uva, que deve ser 2.3.0. A versão estável atual é 2.2.0.
Disponível como parte da assinatura do Tidelift.
Os mantenedores de uva estão trabalhando com o Tidelift para fornecer suporte e manutenção comerciais. Economize tempo, reduza o risco e melhore a saúde do código, enquanto paga aos mantenedores da uva. Clique aqui para mais detalhes.
Ruby 2.7 ou mais recente é necessário.
Uva está disponível como uma jóia, para instalá -la executando:
bundle add grape
APIs de uva são aplicativos de rack criados pela subclassificação Grape::API . Abaixo está um exemplo simples, mostrando alguns dos recursos mais comuns da uva no contexto de recriar partes da API do 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 A depreciador da Grape será adicionada aos depreciadores do seu aplicativo automaticamente como :grape , para que a configuração do seu aplicativo possa ser aplicada a ele.
Por padrão, a uva compilará as rotas na primeira rota, é possível pré-carregar rotas usando a compile! método.
Twitter :: API . compile! Isso pode ser adicionado ao seu config.ru (se estiver usando o rackup), application.rb (se estiver usando o Rails) ou qualquer arquivo que carregue seu servidor.
A amostra acima cria um aplicativo de rack que pode ser executado a partir de um arquivo rackup config.ru com rackup :
run Twitter :: API(Com pré-carregamento que você pode usar)
Twitter :: API . compile!
run Twitter :: APIE responderia às seguintes rotas:
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
A uva também responderá automaticamente à cabeça e às opções para todas as opções, e apenas opções para todas as outras rotas.
Se você deseja montar uva ao lado de outra estrutura de rack como Sinatra, pode fazer isso facilmente usando 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 ] Observe que a ordem dos aplicativos de carregamento usando Rack::Cascade é importante. O aplicativo de uva deve ser o último se você deseja levantar erros personalizados de 404 da uva (como error!('Not Found',404) ). Se o aplicativo de uva não for o último e retornará a resposta 404 ou 405, a Cascade utiliza isso como um sinal para experimentar o próximo aplicativo. Isso pode levar a um comportamento indesejável, mostrando a página 404 errada do aplicativo errado.
Coloque os arquivos da API no app/api . O Rails espera um subdiretório que corresponda ao nome do módulo Ruby e um nome de arquivo que corresponde ao nome da classe. Em nosso exemplo, o local do nome do arquivo e o diretório para Twitter::API deve ser app/api/twitter/api.rb .
Modifique config/routes :
mount Twitter :: API => '/' O AutoLoader padrão do Rails é Zeitwerk . Por padrão, ele infleta api como Api em vez de API . Para fazer nosso exemplo funcionar, você precisa descomentar as linhas na parte inferior da config/initializers/inflections.rb e adicionar API como sigla:
ActiveSupport :: Inflector . inflections ( :en ) do | inflect |
inflect . acronym 'API'
endVocê pode montar várias implementações de API dentro de outra. Estes não precisam ser versões diferentes, mas podem ser componentes da mesma API.
class Twitter :: API < Grape :: API
mount Twitter :: APIv1
mount Twitter :: APIv2
end Você também pode montar em um caminho, que é semelhante ao uso prefix dentro da própria API montada.
class Twitter :: API < Grape :: API
mount Twitter :: APIv1 => '/v1'
end As declarações como before/after/rescue_from podem ser colocadas antes ou depois mount . De qualquer forma, eles serão herdados.
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 Você pode montar os mesmos pontos de extremidade em dois locais diferentes.
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 Supondo que os terminais de postagem e comentários sejam montados em /posts e /comments , agora você deve poder fazer get /posts/votes , post /posts/votes , get /comments/votes e post /comments/votes .
Você pode configurar pontos de extremidade removíveis para alterar a forma como eles se comportam de acordo com onde são montados.
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 Observe que, se você estiver passando um hash como o primeiro parâmetro a ser mount , precisará colocar explicitamente () em torno dos parâmetros:
# good
mount ( { :: Some :: Api => '/some/api' } , with : { condition : true } )
# bad
mount :: Some :: Api => '/some/api' , with : { condition : true } Você pode acessar configuration na classe (para usar como atributos dinâmicos), bloqueios internos (como o namespace)
Se você deseja que a lógica aconteça em uma configuration , você pode usar o ajudante given .
class ConditionalEndpoint :: API < Grape :: API
given configuration [ :some_setting ] do
get 'mount_this_endpoint_conditionally' do
configuration [ :configurable_response ]
end
end
end Se você deseja um bloco de lógica em execução toda vez que um terminal é montado (dentro do qual você pode acessar o 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 Resultados mais complexos podem ser alcançados usando mounted como uma expressão na qual a configuration já é avaliada como um 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 Você tem a opção de fornecer várias versões da sua API, estabelecendo uma classe Grape::API separada para cada versão oferecida e integrando -as em uma classe Grape::API . Verifique se as versões mais recentes são montadas antes das mais antigas. A abordagem padrão para o versão direciona a solicitação para o middleware do rack subsequente se uma versão específica não for encontrada.
require 'v1'
require 'v2'
require 'v3'
class App < Grape :: API
mount V3
mount V2
mount V1
endPara manter os mesmos pontos de extremidade das versões anteriores da API sem reescrever, você pode indicar várias versões nas versões anteriores da API.
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
endUsando o exemplo fornecido, os terminais subsequentes serão acessíveis em várias versões:
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 Existem quatro estratégias nas quais os clientes podem atingir os pontos de extremidade da sua API :: :path , :header , :accept_version_header e :param . A estratégia padrão é :path .
version 'v1' , using : :pathUsando essa estratégia de versão, os clientes devem passar na versão desejada no URL.
curl http://localhost:9292/v1/statuses/public_timeline
version 'v1' , using : :header , vendor : 'twitter'Atualmente, o Uva suporta apenas os tipos de mídia versioned no seguinte formato:
vnd.vendor-and-or-resource-v1234+format
Basicamente, todos os tokens entre o final - e o + serão interpretados como a versão.
Usando essa estratégia de versão, os clientes devem passar na versão desejada no HTTP Accept Head.
curl -H Accept:application/vnd.twitter-v1+json http://localhost:9292/statuses/public_timeline
Por padrão, a primeira versão correspondente é usada quando nenhum cabeçalho Accept é fornecido. Esse comportamento é semelhante ao roteamento em trilhos. Para contornar esse comportamento padrão, pode -se usar a opção :strict . Quando esta opção é definida como true , um erro 406 Not Acceptable é retornado quando nenhum cabeçalho Accept correto é fornecido.
Quando um cabeçalho Accept inválido é fornecido, um erro 406 Not Acceptable será retornado se a opção :cascade estiver definida como false . Caso contrário, um erro 404 Not Found será retornado pelo rack se nenhuma outra rota corresponder.
A uva avaliará a preferência relativa da qualidade incluída nos cabeçalhos de aceitação e a inadimplência para uma qualidade de 1,0 quando omitida. No exemplo seguinte, uma API de uva que suporta XML e JSON nessa ordem retornará JSON:
curl -H "Accept: text/xml;q=0.8, application/json;q=0.9" localhost:1234/resource
version 'v1' , using : :accept_version_header Usando essa estratégia de versão, os clientes devem passar na versão desejada no cabeçalho Accept-Version HTTP.
curl -H "Accept-Version:v1" http://localhost:9292/statuses/public_timeline
Por padrão, a primeira versão correspondente é usada quando nenhum cabeçalho Accept-Version é fornecido. Esse comportamento é semelhante ao roteamento em trilhos. Para contornar esse comportamento padrão, pode -se usar a opção :strict . Quando esta opção é definida como true , um erro 406 Not Acceptable é retornado quando nenhum cabeçalho Accept correto é fornecido e a :cascade está definida como false . Caso contrário, um erro 404 Not Found será retornado pelo rack se nenhuma outra rota corresponder.
version 'v1' , using : :paramUsando essa estratégia de versão, os clientes devem passar na versão desejada como um parâmetro de solicitação, na sequência de consulta URL ou no corpo da solicitação.
curl http://localhost:9292/statuses/public_timeline?apiver=v1
O nome padrão do parâmetro de consulta é 'Apiver', mas pode ser especificado usando a opção :parameter .
version 'v1' , using : :param , parameter : 'v' curl http://localhost:9292/statuses/public_timeline?v=v1
Você pode adicionar uma descrição aos métodos de API e namespaces. A descrição seria usada pela Uva-Swagger para gerar documentação compatível com Swagger.
Nota: O bloco de descrição é apenas para documentação e não afeta o comportamento da 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 : uma descrição mais aprimoradaparams : defina parâmetros diretamente de uma Entitysuccess : (antiga entidade) A Entity a ser usada para apresentar a resposta de sucesso para esta rota.failure : (antigo http_codes) Uma definição dos códigos e entidades HTTP de falha usados.default : a definição e Entity usadas para apresentar a resposta padrão para esta rota.named : um ajudante para dar um nome a uma rota e encontrá -lo com este nome no hash da documentaçãoheaders : uma definição dos cabeçalhos usados Use Grape.configure para configurar configurações globais no tempo de carregamento. Atualmente, as configurações configuráveis são:
param_builder : define o construtor de parâmetros, padroniza para Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder .Para alterar um valor de configuração, verifique se, em algum momento, durante o tempo de carregamento, o código seguinte é executado
Grape . configure do | config |
config . setting = value
end Por exemplo, para o param_builder , o código a seguir pode ser executado em um inicializador:
Grape . configure do | config |
config . param_builder = Grape :: Extensions :: Hashie :: Mash :: ParamBuilder
endVocê também pode configurar uma única API:
API . configure do | config |
config [ key ] = value
end Isso estará disponível dentro da API com configuration , como se fosse a configuração de montagem.
Os parâmetros de solicitação estão disponíveis através do objeto Hash params . Isso inclui parâmetros GET , POST e PUT , juntamente com os parâmetros nomeados que você especificar em suas seqüências de rotas.
get :public_timeline do
Status . order ( params [ :sort_by ] )
end Os parâmetros são preenchidos automaticamente no corpo da solicitação na POST e PUT de formulários, JSON e XML Content-Types.
O pedido:
curl -d '{"text": "140 characters"}' 'http://localhost:9292/statuses' -H Content-Type:application/json -v
O terminal da uva:
post '/statuses' do
Status . create! ( text : params [ :text ] )
endPostagens multipartrárias e puts também são suportadas.
O pedido:
curl --form image_file='@image.jpg;type=image/jpg' http://localhost:9292/upload
O terminal da uva:
post 'upload' do
# file in params[:image_file]
endNo caso de conflito entre qualquer um de:
GET , POST e PUT parâmetrosPOST e PUTOs parâmetros da string de rota terão precedência.
Por padrão, os parâmetros estão disponíveis como ActiveSupport::HashWithIndifferentAccess . Isso pode ser alterado para, por exemplo, rubi Hash ou Hashie::Mash para toda a 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 A classe também pode ser substituída em blocos de parâmetros individuais usando build_with da seguinte maneira.
params do
build_with Grape :: Extensions :: Hash :: ParamBuilder
optional :color , type : String
end Ou globalmente com a configuração Grape.configure.param_builder .
No exemplo acima, params["color"] retornarão nil pois params são um Hash simples.
Os construtores de parâmetros disponíveis são Grape::Extensions::Hash::ParamBuilder , Grape::Extensions::ActiveSupport::HashWithIndifferentAccess::ParamBuilder e Grape::Extensions::Hashie::Mash::ParamBuilder .
A uva permite acessar apenas os parâmetros que foram declarados pelo seu bloco params . Ele vai:
Considere o seguinte endpoint da API:
format :json
post 'users/signup' do
{ 'declared_params' => declared ( params ) }
end Se você não especificar nenhum parâmetros, declared retornará um hash vazio.
Solicitar
curl -X POST -H " Content-Type: application/json " localhost:9292/users/signup -d ' {"user": {"first_name":"first name", "last_name": "last name"}} 'Resposta
{
"declared_params" : {}
}
Depois de adicionar requisitos de parâmetros, a uva começará a retornar apenas os parâmetros declarados.
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 ) }
endSolicitar
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"}} 'Resposta
{
"declared_params" : {
"user" : {
"first_name" : " first name " ,
"last_name" : " last name "
}
}
} Parâmetros ausentes que são declarados como Hash ou Array de tipo serão incluídos.
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 ) }
endSolicitar
curl -X POST -H " Content-Type: application/json " localhost:9292/users/signup -d ' {} 'Resposta
{
"declared_params" : {
"user" : {
"first_name" : null ,
"last_name" : null
},
"widgets" : []
}
} O hash retornado é um ActiveSupport::HashWithIndifferentAccess .
O método #declared não está disponível before dos filtros, pois eles são avaliados antes da coerção de parâmetros.
Por padrão, declared(params) inclui parâmetros que foram definidos em todos os namespaces dos pais. Se você deseja retornar apenas parâmetros do seu espaço de nome atual, poderá definir a opção include_parent_namespaces como 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
endSolicitar
curl -X GET -H " Content-Type: application/json " localhost:9292/parent/foo/barResposta
{
"without_parent_namespaces" : {
"child_name" : " bar "
},
"with_parent_namespaces" : {
"parent_name" : " foo " ,
"child_name" : " bar "
},
} Por padrão, declared(params) inclui parâmetros que possuem valores nil . Se você deseja retornar apenas os parâmetros que não são nil , pode usar a opção include_missing . Por padrão, include_missing está definido como true . Considere a seguinte API:
format :json
params do
requires :user , type : Hash do
requires :first_name , type : String
optional :last_name , type : String
end
end
post 'users/signup' do
{ 'declared_params' => declared ( params , include_missing : false ) }
endSolicitar
curl -X POST -H " Content-Type: application/json " localhost:9292/users/signup -d ' {"user": {"first_name":"first name", "random": "never shown"}} 'Resposta com incluir_missing: false
{
"declared_params" : {
"user" : {
"first_name" : " first name "
}
}
}Resposta com incluir_missing: true
{
"declared_params" : {
"user" : {
"first_name" : " first name " ,
"last_name" : null
}
}
}Também funciona em hashes aninhados:
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 ) }
endSolicitar
curl -X POST -H " Content-Type: application/json " localhost:9292/users/signup -d ' {"user": {"first_name":"first name", "random": "never shown", "address": { "city": "SF"}}} 'Resposta com incluir_missing: false
{
"declared_params" : {
"user" : {
"first_name" : " first name " ,
"address" : {
"city" : " SF "
}
}
}
}Resposta com incluir_missing: true
{
"declared_params" : {
"user" : {
"first_name" : " first name " ,
"last_name" : null ,
"address" : {
"city" : " Zurich " ,
"region" : null
}
}
}
} Observe que um atributo com um valor nil não é considerado ausente e também será retornado quando include_missing for definido como false :
Solicitar
curl -X POST -H " Content-Type: application/json " localhost:9292/users/signup -d ' {"user": {"first_name":"first name", "last_name": null, "address": { "city": "SF"}}} 'Resposta com incluir_missing: false
{
"declared_params" : {
"user" : {
"first_name" : " first name " ,
"last_name" : null ,
"address" : { "city" : " SF " }
}
}
} Por padrão, declared(params) não given e retornará todos os parâmetros. Use evaluate_given para avaliar todos os blocos given e retornar apenas parâmetros que satisfazem given condições. Considere a seguinte API:
format :json
params do
optional :child_id , type : Integer
given :child_id do
requires :father_id , type : Integer
end
end
post 'child' do
{ 'declared_params' => declared ( params , evaluate_given : true ) }
endSolicitar
curl -X POST -H " Content-Type: application/json " localhost:9292/child -d ' {"father_id": 1} 'Resposta com avaliação_given: false
{
"declared_params" : {
"child_id" : null ,
"father_id" : 1
}
}Resposta com avaliação_given: true
{
"declared_params" : {
"child_id" : null
}
}Também funciona em hashes aninhados:
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 ) }
endSolicitar
curl -X POST -H " Content-Type: application/json " localhost:9292/child -d ' {"child": {"father_id": 1}} 'Resposta com avaliação_given: false
{
"declared_params" : {
"child" : {
"child_id" : null ,
"father_id" : 1
}
}
}Resposta com avaliação_given: true
{
"declared_params" : {
"child" : {
"child_id" : null
}
}
} Usando route_param tem maior precedência sobre um parâmetro regular definido com o mesmo nome:
params do
requires :foo , type : String
end
route_param :foo do
get do
{ value : params [ :foo ] }
end
endSolicitar
curl -X POST -H " Content-Type: application/json " localhost:9292/bar -d ' {"foo": "baz"} 'Resposta
{
"value" : " bar "
} Você pode definir validações e opções de coerção para seus parâmetros usando um bloco 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
endQuando um tipo é especificado, uma validação implícita é feita após a coerção para garantir que o tipo de saída seja o declarado.
Parâmetros opcionais podem ter um valor padrão.
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 Os valores padrão são avaliados ansiosamente. Acima :non_random_number será avaliado com o mesmo número para cada chamada para o ponto de extremidade deste bloco params . Para que o padrão avalie preguiçosamente com cada solicitação, use um lambda, como :random_number acima.
Observe que os valores padrão serão passados para quaisquer opções de validação especificadas. O exemplo a seguir sempre falhará se :color não for explicitamente fornecida.
params do
optional :color , type : String , default : 'blue' , values : [ 'red' , 'green' ]
endA implementação correta é garantir que o valor padrão passe todas as validações.
params do
optional :color , type : String , default : 'blue' , values : [ 'blue' , 'red' , 'green' ]
end Você pode usar o valor de um parâmetro como o valor padrão de algum outro parâmetro. Nesse caso, se o parâmetro primary_color não for fornecido, ele terá o mesmo valor que o de color . Se os dois não forem fornecidos, os dois terão valor blue .
params do
optional :color , type : String , default : 'blue'
optional :primary_color , type : String , default : -> ( params ) { params [ :color ] }
endA seguir, todos os tipos válidos, suportados pela caixa por uva:
File de alias)Esteja ciente de que o comportamento difere entre o Ruby 2.4 e as versões anteriores. No Ruby 2.4, os valores que consistem em números são convertidos em número inteiro, mas em versões anteriores, ele será tratado como 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 Além do conjunto padrão de tipos suportados listados acima, qualquer classe pode ser usada como um tipo, desde que seja fornecido um método de coerção explícito. Se o tipo implementar um método parse no nível da classe, a uva usá-lo automaticamente. Este método deve pegar um argumento de string e retornar uma instância do tipo correto ou retornar uma instância de Grape::Types::InvalidValue que opcionalmente aceita uma mensagem a ser retornada na resposta.
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 Como alternativa, um método de coerção personalizado pode ser fornecido para qualquer tipo de parâmetro usando coerce_with . Qualquer classe ou objeto pode ser dado que implementa um método parse ou call , nessa ordem de precedência. O método deve aceitar um único parâmetro de string e o valor de retorno deve corresponder ao type fornecido.
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 Observe que um valor nil chamará o método de coerção personalizado, enquanto um parâmetro ausente não.
Exemplo de uso de coerce_with com uma lambda (uma classe com um método parse também poderia ter sido usada), ele analisará uma string e retornará uma matriz de números inteiros, correspondendo ao type de Array[Integer] .
params do
requires :values , type : Array [ Integer ] , coerce_with : -> ( val ) { val . split ( / s +/ ) . map ( & :to_i ) }
end A uva afirmará que os valores coagidos correspondem ao type fornecido e rejeitarão a solicitação, se não o fizerem. Para substituir esse comportamento, os tipos personalizados podem implementar um parsed? Método que deve aceitar um único argumento e retornar true se o valor passar a validação do tipo.
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 Uva utiliza o suporte interno do Rack::Request para parâmetros de arquivo multipart. Esses parâmetros podem ser declarados com 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 de primeira classe A uva suporta parâmetros complexos fornecidos como seqüências de cordas formatadas por JSON usando o type: JSON . Os objetos JSON e as matrizes de objetos são aceitos igualmente, com regras de validação aninhadas aplicadas a todos os objetos em ambos os casos:
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 type: Array[JSON] pode ser usada, que marca explicitamente o parâmetro como uma matriz de objetos. Se um único objeto for fornecido, ele será embrulhado.
params do
requires :json , type : Array [ JSON ] do
requires :int , type : Integer
end
end
get '/' do
params [ :json ] . each { | obj | ... } # always works
end Para um controle mais rigoroso sobre o tipo de estrutura JSON que pode ser fornecida, use type: Array, coerce_with: JSON ou type: Hash, coerce_with: JSON .
Os parâmetros do tipo variante podem ser declarados usando a opção types em vez de 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"] Como um caso especial, as coleções do tipo de membro variante também podem ser declaradas, passando um Set ou Array com mais de um membro para 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"] Os parâmetros podem ser aninhados usando group ou chamando requires ou optional com um bloco. No exemplo acima, isso significa que params[:media][:url] são necessários juntamente com params[:id] e params[:audio][:format] são necessários apenas se params[:audio] estiverem presentes. Com um bloco, group , requires e optional aceite um type de opção adicional que pode ser Array ou Hash e padronizar a Array . Dependendo do valor, os parâmetros aninhados serão tratados como valores de um hash ou como valores de hashes em uma matriz.
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 Suponha que alguns de seus parâmetros só sejam relevantes se outro parâmetro for fornecido; Grape permite que você expresse esse relacionamento através do método given em seus parâmetros, como assim:
params do
optional :shelf_id , type : Integer
given :shelf_id do
requires :bin_id , type : Integer
end
end No exemplo acima da uva, usará blank? Para verificar se o param shelf_id está presente.
given também leva um Proc com código personalizado. Abaixo, a description do param é necessária apenas se o valor da category for igual foo :
params do
optional :category
given category : -> ( val ) { val == 'foo' } do
requires :description
end
endVocê pode renomear parâmetros:
params do
optional :category , as : :type
given type : -> ( val ) { val == 'foo' } do
requires :description
end
end NOTA: O param em given deve ser renomeado. No exemplo, deve ser type , não category .
As opções de parâmetros podem ser agrupadas. Pode ser útil se você deseja extrair validação ou tipos comuns para vários parâmetros. Dentro desses grupos, os parâmetros individuais podem estender ou substituir seletivamente as configurações comuns, permitindo que você mantenha os padrões no nível do grupo enquanto ainda aplica regras específicas de parâmetros quando necessário.
O exemplo abaixo apresenta um caso típico quando os parâmetros compartilham opções comuns.
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 permite que você apresente a mesma lógica através do método with o bloqueio de parâmetros, assim:
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
endVocê pode organizar as configurações em camadas usando blocos `` 'aninhados. Cada camada pode usar, adicionar ou alterar as configurações da camada acima dela. Isso ajuda a manter parâmetros complexos organizados e consistentes, enquanto ainda permitem ser feitos personalizações específicas.
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 Você pode renomear parâmetros usando as , que podem ser úteis ao refatorar as APIs existentes:
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 O valor passado as será a chave ao chamar declared(params) .
allow_blank Os parâmetros podem ser definidos como allow_blank , garantindo que eles contenham um valor. Por padrão, requires apenas validar apenas que um parâmetro foi enviado na solicitação, independentemente do seu valor. Com allow_blank: false , valores vazios ou espaço em branco apenas os valores são inválidos.
allow_blank pode ser combinado com requires e optional . Se o parâmetro for necessário, ele precisará conter um valor. Se for opcional, é possível não enviá -lo na solicitação, mas se estiver sendo enviado, ele terá algum valor, e não uma string vazia/apenas espaços em branco.
params do
requires :username , allow_blank : false
optional :first_name , allow_blank : false
end values Os parâmetros podem ser restritos a um conjunto específico de valores com a opção :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 O fornecimento de um intervalo para a opção :values garante que o parâmetro esteja (ou os parâmetros estão) incluídos nesse intervalo (usando 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'
endNota Os intervalos intermináveis também são suportados com ActiveSupport> = 6.0, mas exigem que o tipo seja fornecido.
params do
requires :minimum , type : Integer , values : 10 ..
optional :maximum , type : Integer , values : .. 10
end Observe que ambos os pontos de extremidade do intervalo devem ser um #kind_of? Sua opção :type (se você não fornecer a opção :type , ela será adivinhada como igual à classe do primeiro terminal do intervalo). Portanto, o seguinte é inválido:
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 A opção :values também pode ser fornecida com um Proc , avaliado preguiçosamente a cada solicitação. Se o PROC tiver arity zero (ou seja, não leva argumentos), espera -se que ele retorne uma lista ou um intervalo que será usado para validar o parâmetro.
Por exemplo, dado um modelo de status que você pode querer restringir por hashtags que você definiu anteriormente no modelo HashTag .
params do
requires :hashtag , type : String , values : -> { Hashtag . all . map ( & :tag ) }
endComo alternativa, um proc com arity um (ou seja, assumindo um argumento) pode ser usado para validar explicitamente cada valor de parâmetro. Nesse caso, espera -se que o PROC retorne um valor verdadeiro se o valor do parâmetro for válido. O parâmetro será considerado inválido se o PROC retornar um valor falsamente ou se aumentar um StandardError.
params do
requires :number , type : Integer , values : -> ( v ) { v . even? && v < 25 }
endEmbora o PROCS seja conveniente para casos únicos, considere o uso de validadores personalizados nos casos em que uma validação é usada mais de uma vez.
Observe que o validador allow_blank se aplica ao usar :values . No exemplo a seguir, a ausência de :allow_blank não impede :state de receber valores em branco porque :allow_blank padrões para true .
params do
requires :state , type : Symbol , values : [ :active , :inactive ]
end except_values Os parâmetros podem ser impedidos de ter um conjunto específico de valores com a opção :except_values .
O validador except_values se comporta de maneira semelhante ao validador values , pois aceita uma matriz, um intervalo ou um proc. Ao contrário do validador values , no entanto, except_values aceita apenas o Procs com a 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 Uma opção same_as pode ser fornecida para garantir que os valores dos parâmetros correspondam.
params do
requires :password
requires :password_confirmation , same_as : :password
end length Parâmetros com tipos que suportam o método #length podem ser restritos a ter um comprimento específico com a opção :length .
O validador aceita :min ou :max ou ambas as opções ou apenas :is validar que o valor do parâmetro está dentro dos limites fornecidos.
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 Os parâmetros podem ser restritos para corresponder a uma expressão regular específica com a opção :regexp . Se o valor não corresponder à expressão regular, um erro será retornado. Observe que isso é verdade para os parâmetros requires e optional .
params do
requires :email , regexp : /.+@.+/
end O validador passará se o parâmetro foi enviado sem valor. Para garantir que o parâmetro contenha um valor, use allow_blank: false .
params do
requires :email , allow_blank : false , regexp : /.+@.+/
end mutually_exclusive Os parâmetros podem ser definidos como mutually_exclusive , garantindo que não estejam presentes ao mesmo tempo em uma solicitação.
params do
optional :beer
optional :wine
mutually_exclusive :beer , :wine
endVários conjuntos podem ser definidos:
params do
optional :beer
optional :wine
mutually_exclusive :beer , :wine
optional :scotch
optional :aquavit
mutually_exclusive :scotch , :aquavit
endAviso : nunca defina conjuntos mutuamente exclusivos com os parâmetros necessários. Dois parâmetros necessários mutuamente exclusivos significarão que os parâmetros nunca são válidos, tornando o endpoint inútil. Um param exigido mutuamente exclusivo com um parâmetro opcional significa que o último nunca será válido.
exactly_one_ofOs parâmetros podem ser definidos como 'exatamente_one_of', garantindo que exatamente um parâmetro seja selecionado.
params do
optional :beer
optional :wine
exactly_one_of :beer , :wine
end Observe que o uso :default com mutually_exclusive fará com que vários parâmetros sempre tenham um valor padrão e aumentem uma Grape::Exceptions::Validation Exceção mutuamente exclusiva.
at_least_one_ofOs parâmetros podem ser definidos como 'at_least_one_of', garantindo que pelo menos um parâmetro seja selecionado.
params do
optional :beer
optional :wine
optional :juice
at_least_one_of :beer , :wine , :juice
end all_or_none_ofOs parâmetros podem ser definidos como 'all_or_none_of', garantindo que todos ou nenhum dos parâmetros seja selecionado.
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_ofTodos esses métodos podem ser usados em qualquer nível aninhado.
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
endOs espaços de nome permitem definições de parâmetros e aplicam -se a todos os métodos dentro do espaço para nome.
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 O método namespace possui vários aliases, incluindo: group , resource , resources e segment . Use o que lê o melhor para sua API.
Você pode definir convenientemente um parâmetro de rota como um espaço para nome usando 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 Você também pode definir um tipo de parâmetro de rota passando para as opções do 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
endVocê também pode criar classes personalizadas que pegam parâmetros.
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
endVocê também pode criar validação personalizada que use a solicitação para validar o atributo. Por exemplo, se você deseja ter parâmetros disponíveis apenas para administradores, você pode fazer o seguinte.
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
endE use -o em sua definição de terminal como:
params do
optional :admin_field , type : String , admin : true
optional :non_admin_field , type : String
optional :admin_false_field , type : String , admin : false
endCada validação terá sua própria instância do validador, o que significa que o validador pode ter um estado.
Os erros de validação e coerção são coletados e uma exceção do tipo Grape::Exceptions::ValidationErrors é levantada. Se a exceção não for capturada, ela responderá com um status de 400 e uma mensagem de erro. Os erros de validação são agrupados pelo nome do parâmetro e podem ser acessados via Grape::Exceptions::ValidationErrors#errors .
A resposta padrão de uma Grape::Exceptions::ValidationErrors é uma corda humanamente legível, como "cerveja, vinho é mutuamente exclusiva", no exemplo a seguir.
params do
optional :beer
optional :wine
optional :juice
exactly_one_of :beer , :wine , :juice
end Você pode resgatar uma Grape::Exceptions::ValidationErrors e responder com uma resposta personalizada ou transformar a resposta em JSON bem formado para uma API JSON que separa os parâmetros individuais e as mensagens de erro correspondentes. O seguinte exemplo de rescue_from produz [{"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 Retorna as mensagens de validação como uma matriz. Grape::Exceptions::ValidationErrors#message entra nas mensagens em uma string.
Para responder com uma variedade de mensagens de validação, você pode usar Grape::Exceptions::ValidationErrors#full_messages .
format :json
subject . rescue_from Grape :: Exceptions :: ValidationErrors do | e |
error! ( { messages : e . full_messages } , 400 )
end A uva retorna todos os erros de validação e coerção encontrados por padrão. Para pular todas as verificações de validação subsequentes quando um parâmetro específico é encontrado inválido, use fail_fast: true .
O exemplo a seguir não verificará se :wine está presente, a menos que encontre :beer .
params do
required :beer , fail_fast : true
required :wine
end O resultado de parâmetros vazios seria uma única Grape::Exceptions::ValidationErrors Erro.
Da mesma forma, nenhum teste de expressão regular será realizado se :blah estiver em branco no exemplo a seguir.
params do
required :blah , allow_blank : false , regexp : /blah/ , fail_fast : true
endA uva suporta I18N para mensagens de erro relacionadas a parâmetros, mas fará fallback para o inglês se as traduções para o local padrão não tiverem sido fornecidas. Veja o en.yml para obter as chaves de mensagem.
Caso o seu aplicativo aplique apenas os locais disponíveis e: EN não está incluído nos locais disponíveis, a uva não pode voltar ao inglês e retornará a chave de tradução para a mensagem de erro. Para evitar esse comportamento, forneça uma tradução para o seu local padrão ou adicione: pt aos locais disponíveis.
A uva suporta mensagens de validação personalizadas para mensagens de erro relacionadas a parâmetros e relacionadas a coerces.
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 translationsVocê pode passar um símbolo se desejar traduções i18n para suas mensagens de validação personalizadas.
params do
requires :name , message : :name_required
end # en.yml
en :
grape :
errors :
format : ! '%{attributes} %{message}'
messages :
name_required : 'must be present' Você também pode substituir nomes de atributos.
# en.yml
en :
grape :
errors :
format : ! '%{attributes} %{message}'
messages :
name_required : 'must be present'
attributes :
name : 'Oops! Name'Produzirá 'oops! O nome deve estar presente '
Você não pode definir uma opção de mensagem personalizada para padrão, pois requer interpolação %{option1}: %{value1} is incompatible with %{option2}: %{value2} . Você pode alterar a mensagem de erro padrão para padrão alterando a tecla incompatible_option_values Message Inside en.yml
params do
requires :name , values : { value : -> { ( 1 .. 10 ) . to_a } , message : 'not in range from 1 to 10' } , default : 5
enddry-validation ou dry-schema Como alternativa ao DSL params descrito acima, você pode usar um esquema ou contrato dry-validation para descrever os parâmetros de um endpoint. Isso pode ser especialmente útil se você já usar o acima, em algumas outras partes do seu aplicativo. Caso contrário, você precisará adicionar dry-validation ou dry-schema ao seu Gemfile .
Em seguida, ligue para contract com um contrato ou esquema definido anteriormente:
CreateOrdersSchema = Dry :: Schema . Params do
required ( :orders ) . array ( :hash ) do
required ( :name ) . filled ( :string )
optional ( :volume ) . maybe ( :integer , lt? : 9 )
end
end
# ...
contract CreateOrdersSchemaou com um bloco, usando a sintaxe da definição do esquema:
contract do
required ( :orders ) . array ( :hash ) do
required ( :name ) . filled ( :string )
optional ( :volume ) . maybe ( :integer , lt? : 9 )
end
end Este último definirá um esquema de coagir ( Dry::Schema.Params ). Ao usar a abordagem anterior, cabe a você decidir se a entrada precisará de coagir.
Os params e declarações contract também podem ser usados juntos na mesma API, por exemplo, para descrever diferentes partes de um espaço de nome aninhado para um terminal.
Os cabeçalhos de solicitação estão disponíveis através do ajudante headers ou da env em sua forma original.
get do
error! ( 'Unauthorized' , 401 ) unless headers [ 'Secret-Password' ] == 'swordfish'
end get do
error! ( 'Unauthorized' , 401 ) unless env [ 'HTTP_SECRET_PASSWORD' ] == 'swordfish'
end O exemplo acima pode ter sido solicitado da seguinte maneira:
curl -H " secret_PassWord: swordfish " ...O nome do cabeçalho terá sido normalizado para você.
header serão coagidos em um estojo de kebab baseado em baixo como secret-password se estiver usando o rack 3.header , serão coagidos em um caso de kebab capitalizado como Secret-PassWord se usar o rack <3.env eles aparecem em toda a maçaneta, no caso Snake, e prefixados com 'http_' como HTTP_SECRET_PASSWORDO nome do cabeçalho terá sido normalizado pelos padrões HTTP definidos na Seção 4.2 RFC2616, independentemente do que está sendo enviado por um cliente.
Você pode definir um cabeçalho de resposta com header dentro de uma API.
header 'X-Robots-Tag' , 'noindex' Ao levantar error! , passe cabeçalhos adicionais como argumentos. Cabeçalhos adicionais serão fundidos com cabeçalhos definidos antes error! chamar.
error! 'Unauthorized' , 401 , 'X-Error-Detail' => 'Invalid token.' Para definir rotas, você pode usar o método route ou as abreviação dos verbos HTTP. Para definir uma rota que aceite qualquer rota definida para :any . Partes do caminho que são indicadas com um cólon serão interpretadas como parâmetros de rota.
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 Para declarar um espaço para nome que prefixa todas as rotas, use o método namespace . group , resource , resources e segment são aliases a esse método. Quaisquer pontos de extremidade dentro de compartilharão o contexto dos pais, bem como qualquer configuração feita no contexto do namespace.
O método route_param é um método conveniente para definir um segmento de rota de parâmetro. Se você definir um tipo, ele adicionará uma validação para este parâmetro.
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
endOpcionalmente, você pode definir requisitos para os parâmetros de rota nomeados usando expressões regulares em namespace ou terminal. A rota corresponderá apenas se todos os requisitos forem atendidos.
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 Você pode definir métodos auxiliares que seus pontos de extremidade podem usar com a macro helpers , dando um bloco ou uma variedade de módulos.
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 Você pode definir params reutilizáveis usando 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 Você também pode definir params reutilizáveis usando ajudantes compartilhados.
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 Os ajudantes suportam blocos que podem ajudar a definir valores padrão. A API a seguir pode retornar uma coleção classificada por id ou created_at em ordem asc ou 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 Se você precisar de métodos para gerar caminhos dentro de seus pontos de extremidade, consulte a gema-helpers da uva-rota.
Você pode anexar documentação adicional aos params usando um hash documentation .
params do
optional :first_name , type : String , documentation : { example : 'Jim' }
requires :last_name , type : String , documentation : { example : 'Smith' }
endSe não for necessário documentação (por exemplo, é uma API interna), a documentação pode ser desativada.
class API < Grape :: API
do_not_document!
# endpoints...
endNesse caso, a uva não criará objetos relacionados à documentação que são mantidos em RAM para sempre.
Você pode definir, obter e excluir seus cookies, simplesmente usando o método 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
endUse uma sintaxe baseada em hash para definir mais de um valor.
cookies [ :status_count ] = {
value : 0 ,
expires : Time . tomorrow ,
domain : '.twitter.com' ,
path : '/'
}
cookies [ :status_count ] [ :value ] += 1 Exclua um biscoito com delete .
cookies . delete :status_countEspecifique um caminho opcional.
cookies . delete :status_count , path : '/' Por padrão, a uva retorna um 201 para POST -REQUESTS, 204 para DELETE solicitações que não retornam nenhum conteúdo e 200 código de status para todas as outras solicitações. Você pode usar status para consultar e definir o código de status HTTP real
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! chamar.
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).Exemplo:
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.
