ocaml webmachine

OCAML-Webmachine

OCAML-Webmaachine ist eine Schicht über CoHTTP, die einen auf staatlich machine basierenden HTTP-Anforderungsprozessor implementiert. Es ist besonders gut geeignet, um erholsame APIs zu schreiben. Wie der Name schon sagt, ist dies ein OCAML -Port des Webmachine -Projekts.

Installation

Installieren Sie die Bibliothek und ihre Abhängigkeiten über OPAM:

opam install webmachine

Erste Schritte

Webmaachine implementiert dieses Entscheidungsdiagramm, um festzustellen, wie eine HTTP -Anfrage behandelt werden sollte. Dies umfasst Validierung, Authentifizierung, Inhaltsverhandlungen und Zwischenspeicher. Eine Ressource gibt die Entscheidung an, die an jedem Knoten im Diagramm getroffen werden sollte, indem die entsprechende Methode in einer resource definiert wird. Die Korrespondenz wird vorerst unter dem Namen der Methode vorgeschlagen. Dies wird in Zukunft besser dokumentiert.

Beispiele

Um die Beispiele in den examples/ Unterverzeichnissen zu erstellen:

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

Entwicklung

Um Entwicklungsabhängigkeiten zu installieren, stecken Sie das Paket aus dem Stammwurzel des Repositorys:

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

Danach können Sie eine Entwicklungsversion der Bibliothek mit dem gewohnten Installationsbefehl installieren.

Um die Tests während der Entwicklung zu erstellen und durchzuführen, müssen Sie das oUnit -Paket installieren und Tests ausführen:

opam install oUnit
dune runtest

Lizenz

BSD3, siehe Lizenzdatei für seinen Text.