https://github.com/inhabitedtype/ocaml-dispatch
Path-based dispatching for client- and server-side applications.
https://github.com/inhabitedtype/ocaml-dispatch
web
Last synced: 11 months ago
JSON representation
Path-based dispatching for client- and server-side applications.
- Host: GitHub
- URL: https://github.com/inhabitedtype/ocaml-dispatch
- Owner: inhabitedtype
- License: other
- Created: 2015-10-14T15:23:24.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-09-26T08:56:20.000Z (over 3 years ago)
- Last Synced: 2025-04-26T07:35:18.515Z (about 1 year ago)
- Topics: web
- Language: OCaml
- Size: 104 KB
- Stars: 45
- Watchers: 7
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ocaml - dispatch - based dispatching for client- and server-side applications. (Web Development)
README
# ocaml-dispatch
ocaml-dispatch provides a basic mechanism for dispatching a request to a
handler based on hierarchical path names conventionally found in URIs. It can be
used both for dispatching requests in a server, as well as handing changes to
hierarchical fragments in a client-side application.
[](https://travis-ci.org/inhabitedtype/ocaml-dispatch)
## Installation
Install the library and its depenencies via [OPAM][opam]:
[opam]: http://opam.ocaml.org/
```bash
opam install dispatch
```
## Development
To install development versions of the library, pin the package from the root
of the repository:
```bash
opam pin add .
```
You can install the latest changes by commiting them to the local git
repository and running:
```bash
opam upgrade dispatch
```
For building and running the tests during development, you will need to install
the `alcotest` package and reconfigure the build process to enable tests:
```bash
opam install alcotest
dune runtest
```
## Usage
Dispatch is designed to work with whatever sort of handler you care to use,
whether it's synchronous, Lwt-based, or Async-based. Here's a simple example of
using the `Dispatch.DSL` module to setup routing for a "Hello, World!" server.
The example assumes a `Server` module and `request` type, and that handlers
should return strings that will be interpreted as the body of the response.
```ocaml
open Dispatch
let hello_handler keys rest request =
let who = try List.assoc "who" keys with Not_found -> "World" in
Printf.sprintf "Hello, %s!" who
;;
let handler request =
let routes =
DSL.create
[ "/" , hello_handler
; "/hello/:who/", hello_handler
]
in
match dispatch routes request.path with
| Some handler -> handler request
| None -> "Not found!"
;;
let _ =
Server.start handler
```
## License
BSD3, see LICENSE file for its text.