package tiny_httpd
Install
Dune Dependency
Authors
Maintainers
Sources
md5=110b74004889058151e06ebecc12d3df
sha512=65a4bda0d95f6ac566350b15f5b8174cce3de9dc56c035cf8b9b015fb63b6dbe33fcadc687891ff777301883b6c685f220a2b8ad297efa561ff75c188ed6b5ef
Description
README
Tiny_httpd
Minimal HTTP server using good old threads, with stream abstractions, simple routing, URL encoding/decoding, and optional compression with camlzip. It also supports server-sent events (w3c)
Free from all forms of ppx, async monads, etc. 🙃
Note: it can be useful to add the jemalloc opam package for long running server, as it does a good job at controlling memory usage.
The basic echo server from src/examples/echo.ml:
module S = Tiny_httpd
let () =
let server = S.create () in
(* say hello *)
S.add_route_handler ~meth:`GET server
S.Route.(exact "hello" @/ string @/ return)
(fun name _req -> S.Response.make_string (Ok ("hello " ^name ^"!\n")));
(* echo request *)
S.add_route_handler server
S.Route.(exact "echo" @/ return)
(fun req -> S.Response.make_string (Ok (Format.asprintf "echo:@ %a@." S.Request.pp req)));
Printf.printf "listening on http://%s:%d\n%!" (S.addr server) (S.port server);
match S.run server with
| Ok () -> ()
| Error e -> raise e
$ dune exec src/examples/echo.exe &
listening on http://127.0.0.1:8080
# the path "hello/name" greets you.
$ curl -X GET http://localhost:8080/hello/quadrarotaphile
hello quadrarotaphile!
# the path "echo" just prints the request.
$ curl -X GET http://localhost:8080/echo --data "howdy y'all"
echo:
{meth=GET;
headers=Host: localhost:8080
User-Agent: curl/7.66.0
Accept: */*
Content-Length: 10
Content-Type: application/x-www-form-urlencoded;
path="/echo"; body="howdy y'all"}
http_of_dir
Similar to python -m http.server, a simple program http_of_dir is provided. It serves files from the current directory.
$ http_of_dir . -p 8080 &
$ curl -X GET http://localhost:8080
...
<html list of current dir>
...
Why?
Why not? If you just want a super basic local server (perhaps for exposing data from a local demon, like Cups or Syncthing do), no need for a ton of dependencies or high scalability libraries.
Use cases might include:
serve content directly from a static blog generator;
provide a web UI to some tool (like CUPS and syncthing do);
implement a basic monitoring page for a service;
provide a simple json API for a service, on top of http;
use
http_of_dirto serve odoc-generated docs or some assets directory.
Documentation
See https://c-cube.github.io/tiny_httpd
License
MIT.
Dependencies (3)
-
ocaml
>= "4.04.0" - base-threads
-
dune
>= "2.0"
Dev Dependencies (5)
Used by (5)
-
google-drive-ocamlfuse
>= "0.7.28" - html_of_jsx
-
owi
>= "0.2" - server-reason-react
-
tiny_httpd_camlzip
= "0.10"
Conflicts
None