grip~grip-framework

A microframework for building RESTful web applications, with ease and joy grip web-framework websocket phoenix routing router kemal microframework
4.0.4 Latest release released
grip-framework/grip
126 9
Grip Framework

The microframework for writing powerful web applications.

Notice: Versions below 4.0.0 are not maintained anymore.

Travis Status Actions Status

TechEmpower Benchmark

Docs CI Status

Chat on Gitter

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.

Motivation

This project exists due to the fact that Kemal lacks one crucial part of a framework, a structure. An example for the absence of an structure can be found here.

Features

  • HTTP 1.1 support.
  • WebSocket RFC 6455 support.
  • Built-in exceptions support.
  • Parameter handling support.
  • JSON serialization and deserialization support.
  • Built-in middleware support.
  • Request/Response context, inspired by expressjs.
  • Advanced routing support.

Code example

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")
  end
end

class Application < Grip::Application
  def routes
    pipeline :api, [
        Pipes::PoweredByHeader.new
    ]

    pipeline :web, [
        Pipes::SecureHeaders.new
    ]

    scope "/api/v1" do
      pipe_through [:web, :api]

      get "/", IndexController
    end

    get "/:id", IndexController, as: :index
  end
end

app = Application.new
app.run

Installation

Add this to your application's shard.yml:

dependencies:
  grip:
    github: grip-framework/grip

And run this command in your terminal:

shards install

API Reference

Documentation can be found on the official website of the Grip framework.

Contribute

See our contribution guidelines and read the code of conduct.

Contributors

Thanks

  • Kemal - Underlying routing, parameter parsing and filtering mechanisms.
  • Amber - Static file handler, ideas and inspiration.
  • Gitter - Technical help, feedback and framework design tips.
  • Crystal - Detailed documentation, examples.
grip:
  github: grip-framework/grip
  version: ~> 4.0.4
License MIT
Crystal 0.35.1

Authors

Dependencies 5

Development Dependencies 1

  • ameba
    {'github' => 'crystal-ameba/ameba'}

Dependents 0

Similar shards

Last synced .
search fire star recently