ocaml webmachine

ocaml-webmachine

OCAML-Webmachine est une couche au-dessus de CoHTTP qui implémente un processeur de demande HTTP basé sur la machine d'état. Il est particulièrement bien adapté à l'écriture d'API RESTful. Comme son nom l'indique, il s'agit d'un port OCAML du projet WebMachine.

Installation

Installez la bibliothèque et ses fonctionnalités via OPAM:

opam install webmachine

Commencer

WebMachine met en œuvre ce diagramme de décision pour déterminer comment une demande HTTP doit être traitée. Cela comprend la validation, l'authentification, la négociation de contenu et la mise en cache. Une ressource spécifie la décision qui doit être prise à chaque nœud du diagramme en définissant la méthode appropriée dans une sous-classe resource . La correspondance est suggérée par le nom de la méthode pour l'instant. Ce sera mieux documenté à l'avenir.

Exemples

Pour construire les exemples dans les examples/ sous-répertoire:

dune build examples/hello_lwt.exe
dune build examples/crud_lwt.exe
dune build examples/hello_async.exe

Développement

Pour installer des dépendances de développement, épinglez le package à partir de la racine du référentiel:

opam pin add -n webmachine .
opam install --deps-only webmachine

Après cela, vous pouvez installer une version de développement de la bibliothèque en utilisant la commande d'installation comme d'habitude.

Pour construire et exécuter les tests pendant le développement, vous devrez installer le package oUnit et exécuter les tests:

opam install oUnit
dune runtest

Licence

BSD3, voir le fichier de licence pour son texte.