joshgoebel / moonshine-1

Web framework for Crystal language

Moonshine

Moonshine is a minimal web framework for the Crystal language. Code speaks louder than words, so here's an example

include Moonshine
include Moonshine::Shortcuts

app = Moonshine::App.new

# respond to all HTTP verbs
app.route "/", do |request|
	ok("Hello Moonshine!")
end

# or particular HTTP verbs
app.get "/get", do |request|
	ok("This is a get response")
end

# you can set response headers
app.get "api", do |request|
	res = ok("{ name : 'moonshine'}")
	res.headers["Content-type"] = "text/json"
	res
end

Error Handlers

# add error handlers
app.error_handler "404", do |req|
	Moonshine::Response.new(404, "Not found")
end

Middleware

# add request middleware
app.request_middleware do |req|
	unless req.headers["user"]
		Moonshine::MiddlewareResponse.new(
			Moonshine::Response.new(200, "Not allowed"),
			pass_through = false
			)
	else
		Moonshine::MiddlewareResponse.new
	end
end

To add a request middleware, call app.request_middleware with a block that returns a Moonshine::MiddlewareResponse object. If the @pass_through attribute of the MiddlewareResponse is true, other request middlewares will be called. Otherwise the @response attribute will be directly returned

Static Files

To serve a static directory, pass an array of paths to Moonshine::App's constructor app = Moonshine::App.new(static_dirs = ["res"])