Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/inhabitedtype/ocaml-webmachine
A REST toolkit for OCaml
https://github.com/inhabitedtype/ocaml-webmachine
http ocaml web webmachine
Last synced: 29 days ago
JSON representation
A REST toolkit for OCaml
- Host: GitHub
- URL: https://github.com/inhabitedtype/ocaml-webmachine
- Owner: inhabitedtype
- License: other
- Created: 2015-03-09T06:03:10.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-10-19T11:54:49.000Z (about 3 years ago)
- Last Synced: 2024-09-29T06:41:09.386Z (about 1 month ago)
- Topics: http, ocaml, web, webmachine
- Language: OCaml
- Homepage:
- Size: 335 KB
- Stars: 223
- Watchers: 19
- Forks: 31
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - ocaml-webmachine
README
# ocaml-webmachine
ocaml-webmachine is a layer on top of [cohttp][] that implements a
state-machine-based HTTP request processor. It's particularly well-suited for
writing RESTful APIs. As the name suggests, this is an OCaml port of the
[webmachine][] project.
[cohttp]: https://github.com/mirage/ocaml-cohttp
[webmachine]: https://github.com/webmachine/webmachine
[](https://travis-ci.com/inhabitedtype/ocaml-webmachine)
## Installation
Install the library and its depenencies via [OPAM][opam]:
[opam]: http://opam.ocaml.org/
```bash
opam install webmachine
```
## Getting Started
webmachine implements [this decision diagram][diagram] to determine how an HTTP
request should be handled. This includes validation, authentication, content
negotiation, and caching. A resource specifies the decision that should be made
at each node in the diagram by defining the appropriate method in a `resource`
subclass. The correspondence is suggested by the name of the method for now.
This will be better-documented in the future.
### Examples
To build the examples in the [`examples/`][examples_dir] subdirectory:
```bash
dune build examples/hello_lwt.exe
dune build examples/crud_lwt.exe
dune build examples/hello_async.exe
```
[diagram]: https://raw.githubusercontent.com/webmachine/webmachine/develop/docs/http-headers-status-v3.png
[examples_dir]: examples/
## Development
To install development dependencies, pin the package from the root of the
repository:
```bash
opam pin add -n webmachine .
opam install --deps-only webmachine
```
After this, you may install a development version of the library using the
install command as usual.
For building and running the tests during development, you will need to install
the `oUnit` package and run tests:
```bash
opam install oUnit
dune runtest
```
## License
BSD3, see LICENSE file for its text.