package yurt

All checked builds pass
  1. Overview
  2. Docs
An HTTP framework for OCaml

Install 

dune-project
 Dependency

github.com Readme Changelog ISC License Edit opam file Versions (2)

Authors

  1. Z
    Zach Shipko

Maintainers

  1. Z
    Zach Shipko <zachshipko@gmail.com>

Sources

yurt-0.6.tbz
sha256=35b5c3e2e89d2a786d117109fc93e2fa501ed87e925d846d45573e95ab266815
md5=881c8406d690a5ebb896a57ae93d04ec

Description

Yurt provides a simple API for creating HTTP servers based on Cohttp and Lwt. See https://github.com/zshipko/yurt for more information.

Added to opam-repository:

README

Yurt

yurt is an HTTP microframework for OCaml based on Cohttp.

Features

  • Simple API
  • Multipart forms
  • Regex based URL routing
  • Functional templates

Installation

opam install yurt

Usage

open Yurt

let _ =
let open Server in

(* Create a server *)
server "127.0.0.1" 1234

(* Add a handler *)
>| get "/<name:string>" (fun req params body ->
    (* Get the url parameter called `name` *)
    let name = Route.string params "name" in
    let body = Yurt_html.h1 (Printf.sprintf "Hello %s!\n" name) in
    html body)

(* Run it *)
|> run

See example/example.ml for more examples.

Dependencies (6)

  1. ezjsonm >= "0.5.0"
  2. lwt_log >= "1.0.0"
  3. cohttp-lwt-unix >= "1.0.0"
  4. conduit-lwt-unix >= "1.0.0" & < "2.3.0"
  5. dune
  6. ocaml >= "4.03.0"

Dev Dependencies

None

Optional Dependencies

None

Used by

None

Conflicts

None

Build status

Results of building yurt with each compiler on check.ci.ocaml.org, run of against opam-repository 8a77e58. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
0.6 (this version) good good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure