search fire star recently

grip

An object-oriented framework based on Kemal with additional goodness

0.27.2 Latest release released
grkek/grip
26 1

This repo seems to be no longer available at grkek/grip.

Git synchronization failed . Last successful sync was .

Help find it again! … or have it archived.

Grip

Grip

Class oriented fork of the Kemal framework based on a JSON request/response model.

Currently Grip is headed towards a JSON request/response type interface, which makes this framework non-HTML friendly, it is still possible to render HTML but it is not advised to use Grip for that purpose.

So far at 285,013 requests/second, and still going.

Build Status

Super Simple ⚡️

require "grip"

class IndexHttpConsumer < Grip::HttpConsumer
  def get(req)
    # The status code is a mix of a built-in and an integer,
    # By default every res has a 200 OK status response.
    json({"id" => 1}, 200)
  end

  def post(req)
    puts url # This gets the hash instance of the route url specified variables
    puts query # This gets the query parameters passed in with the url
    puts json # This gets the JSON data which was passed into the route
    puts headers # This gets the http headers
    
    json({"id" => url["id"]}, HTTP::Status::OK)
  end
end

class EchoWebSocketConsumer < Grip::WebSocketConsumer
  def on_message(req, message)
    send message
  end
end

# Routing
class IdApi < Grip::Application
  scope do
    get "/", IndexHttpConsumer
    post "/:id", IndexHttpConsumer
    ws "/:id", EchoWebSocketConsumer
  end
end

# Run the server
id_api = IdApi.new
id_api.run

The default port of the application is 3000, you can set it by either compiling it and providing a -p flag or by changing it from the source code.

Start your application!

Installation

Add this to your application's shard.yml:

dependencies:
  grip:
    github: grkek/grip

Features

  • Support all REST verbs
  • Websocket support
  • Request/Response context, easy parameter handling
  • Middleware support
  • Built-in JSON support

Documentation

  • For the framework development just use the crystal docs feature and browse through the module.
  • Check out the official documentation available here

Thanks

Thanks to Manas for their awesome work on Frank.

Thanks to Serdar for the awesome work on Kemal.

Thanks to the official gitter chat of the Crystal programming language.

grip:
  github: grkek/grip
  version: ~> 0.27.2

Authors

  • Serdar Dogruyol
  • Giorgi Kavrelishvili

License

MIT

Crystal

0.32.0

Dependencies 1

  • radix
    {'github' => 'luislavena/radix'}

Development Dependencies 1

  • ameba ~> 0.10.0
    {'github' => 'crystal-ameba/ameba', 'version' => '~> 0.10.0'}

Dependents 0

Similar shards

Last synced .