Drash

Drash is a microframework for Deno based on HTTP resources and content negotiation.

Drash is designed to help you build your project(s) quickly with the ability to scale. You can build an API, a SaaS, a web app, an SPA (like the documentation pages), or even a static HTML site. You can even just use it as a logging tool for your other project. How you use Drash is up to you, so that it can be everything you need and nothing you don’t.

Although this module is working, it is still very much under development and subject to breaking changes (from both Deno and Drash source code). For the most part, Drash stays up to date with breaking changes from Deno, but not all breaking changes are fixed immediately. Reporting of bugs and feature requests are greatly appreciated.

View Documentation (still a work in progress)

Install

// Import Drash master
import Drash from "https://deno.land/x/drash/mod.ts";

// Import Drash latest release or specific version
import Drash from "https://deno.land/x/drash@{latest|version}/mod.ts";

An Example HTML Application

Create /path/to/your/project/app.ts …

import Drash from "https://deno.land/x/drash/mod.ts";

class HomeResource extends Drash.Http.Resource {
  static paths = ["/"];
  public GET() {
    this.response.body = "Hello World!";
    return this.response;
  }
}

let server = new Drash.Http.Server({
  address: "localhost:8000",
  response_output: "text/html",
  resources: [HomeResource]
});

server.run();

… and run /path/to/your/project/app.ts

$ deno /path/to/your/project/app.ts --allow-net --allow-env

Deno server started at localhost:8000. Press CTRL+C to quit.

Features

HTTP Resources

Drash uses HTTP resources. It doesn’t use controllers and it doesn’t use app.get('/', someHandler())-like syntax. You create a resource class, define its URIs, and give it HTTP methods (e.g., GET(), POST(), PUT(), DELETE(), etc.).

Content Negotiation

Drash is based on resources and you can’t have true resources unless clients can request different representations of those resources through content negotiation. Drash ships with application/json, text/html, application/xml, and text/xml handling just to meet the needs of standard APIs and web apps. However, you can add more content types for your Drash server to handle. See Adding More Content Types for further information.

Request Path Params (e.g., /users/:id)

If you want to build your RESTful/ish API, then go ahead and use your path params. Resources can access their URI’s path params via this.request.path_params.some_param.

Request URL Query Params (e.g., /users?id=1234)

Can’t have path params and not have request URL query params. Resources can access the request’s URL query params via this.request.url_query_params.some_param.

Semantic Method Names

If you want your resource class to allow GET requests, then give it a GET() method. If you want your resource class to allow POST requests, then give it a POST() method. If you don’t want your resource class to allow DELETE requests, then don’t give your resource class a DELETE() method. Pretty simple ideology and very semantic.