The microframework for writing powerful web applications.
Grip is a microframework for building RESTful web applications. It is designed to be modular and easy to use, with the ability to scale up to the limits of the Crystal programming language. It offers extensibility and has integrated middleware called "pipes". Pipes can alter parts of the request/response context and then get passed to the actual endpoint. Grip's router is very similar to the router of the Phoenix framework. And most of all: Grip is fast.
This project exists due to the fact that Kemal lacks one crucial part of a framework, a structure. An example for the absence of a structure can be found here.
- HTTP 1.1 support.
- WebSocket RFC 6455 support.
- Built-in exceptions support.
- Parameter handling support.
- JSON serialization and deserialization support (fastest framework with JSON in Crystal).
- Middleware support.
- Request/Response context, inspired by expressjs.
- Advanced routing support.
Add this to your application's application.cr
:
require "grip"
class IndexController < Grip::Controllers::Http
def get(context : Context) : Context
context
.put_status(200) # Assign the status code to 200 OK.
.json({"id" => 1}) # Respond with JSON content.
.halt # Close the connection.
end
def index(context : Context) : Context
id =
context
.fetch_path_params
.["id"]
# An optional secondary argument gives a custom `Content-Type` header to the response.
context
.json(content: {"id" => id}, content_type: "application/json; charset=us-ascii")
.halt
end
end
class Application < Grip::Application
def initialize(environment : String)
# By default the environment is set to "development".
super(environment)
scope "/api" do
scope "/v1" do
get "/", IndexController
get "/:id", IndexController, as: :index
end
end
# Enable request/response logging.
router.insert(0, Grip::Handlers::Log.new)
end
end
app = Application.new(environment: "development")
app.run
Add this to your application's shard.yml
:
dependencies:
grip:
github: grip-framework/grip
And run this command in your terminal:
shards install
Documentation can be found on the official website of the Grip framework or the CrystalDoc website.
See our contribution guidelines and read the code of conduct.