Module: Sinatra::Schema

Defined in:
lib/sinatra/schema.rb,
lib/sinatra/schema/link.rb,
lib/sinatra/schema/root.rb,
lib/sinatra/schema/error.rb,
lib/sinatra/schema/utils.rb,
lib/sinatra/schema/version.rb,
lib/sinatra/schema/resource.rb,
lib/sinatra/schema/dsl/links.rb,
lib/sinatra/schema/definition.rb,
lib/sinatra/schema/dsl/resources.rb,
lib/sinatra/schema/param_parsing.rb,
lib/sinatra/schema/dsl/definitions.rb,
lib/sinatra/schema/param_validation.rb

Defined Under Namespace

Modules: DSL, ParamParsing, ParamValidation Classes: BadParams, BadReference, BadRequest, Definition, Error, Link, Resource, Root, Utils

Constant Summary collapse

VERSION = 
"0.0.5"

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.registered(app) ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/sinatra/schema.rb', line 20

def self.registered(app)
  app.helpers ParamParsing
  app.helpers ParamValidation

  app.error(Sinatra::Schema::BadRequest) do |e|
    halt(400, MultiJson.encode(error: e.message))
  end

  app.error(Sinatra::Schema::BadParams) do |e|
    halt(422, MultiJson.encode(error: e.message))
  end

  app.get "/schema" do
    content_type("application/schema+json")
    response.headers["Cache-Control"] = "public, max-age=3600"
    MultiJson.encode(app.schema_root.to_schema, pretty: true)
  end
end

Instance Method Details

#resource(path) {|spec| ... } ⇒ Object

Yields:

  • (spec) 


43
44
45
46
47
 
# File 'lib/sinatra/schema.rb', line 43

def resource(path)
  spec = DSL::Resources.new(self, path)
  yield(spec)
  schema_root.add_resource(spec.resource)
end

#schema_root ⇒ Object 



39
40
41
 
# File 'lib/sinatra/schema.rb', line 39

def schema_root
  Root.instance
end