# route

**Repository Path**: mirrors_tinymce/route

## Basic Information

- **Project Name**: route
- **Description**: route - http request routing
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-26
- **Last Updated**: 2026-05-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

NAME
        route - a library for pattern matching and dispatching http requests

DESCRIPTION
	Route is a library of data types and combinators for matching
        http requests. The matching mechanism allows the library to 
        build dispatch/routing tables for web applications.

USAGE
	The library is pretty straight forward to use. Simply:
          . import io.mth.route._
          . build a route using the combinators available
          . evaluate routes for each request

        A simple example:

          import io.mth.route._

          val route = 
            ("book" <%> stringtoken).route(book =>  // match urls with 2 framents starting with book
              Get(getbook(book)) |                  // for those urls, dispatch to getbook when the method is Get
              Put(createbook(book))                 // for those urls, dispatch to createbook when the method is Put
            ) | ("people" </> "authors").route(     // otherwise if the url is exactly people/authors
              Get(listauthors)                      // and the method is get dispatch to listauthors
            )

          val req = request(Get, "book" </> "1984", text.html)
 
          val res = route(req)
 
STATE
        The `route` library has a stable scala API for version 1.0.

LIMITATIONS
        Currently there are four missing features planned for 
        version 2:
          1. A clean java API.
          2. Combinators for routing multiple matchers to one target.
          3. Better access to request including headers and query
             parameters.
          4. WriterT based tracing of route evaluation.

AUTHOR
        Mark Hibberd <mark@hibberd.id.au>
        Nick Hibberd <nhibberd@gmail.com>

NOTES
        1. official repository
           https://github.com/markhibberd/route
        2. site and documentation
           http://route.mth.io
        3. license (3 point BSD style)
           https://github.com/markhibberd/route/blob/master/LICENSE