ocaml webmachine

ocaml-webmachine

O OCAML-WebMachine é uma camada em cima do COHTTP que implementa um processador de solicitação HTTP baseado em máquina-máquina. É particularmente adequado para escrever APIs RESTful. Como o nome sugere, esta é uma porta OCAML do projeto WebMachine.

Instalação

Instale a biblioteca e suas depenências via Opam:

opam install webmachine

Começando

WebMachine implementa esse diagrama de decisão para determinar como uma solicitação HTTP deve ser tratada. Isso inclui validação, autenticação, negociação de conteúdo e armazenamento em cache. Um recurso especifica a decisão que deve ser tomada em cada nó no diagrama, definindo o método apropriado em uma subclasse resource . A correspondência é sugerida pelo nome do método por enquanto. Isso será mais bem documentado no futuro.

Exemplos

Para construir os exemplos nos examples/ subdiretório:

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

Desenvolvimento

Para instalar dependências de desenvolvimento, fixar o pacote da raiz do repositório:

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

Depois disso, você pode instalar uma versão de desenvolvimento da biblioteca usando o comando de instalação como de costume.

Para construir e executar os testes durante o desenvolvimento, você precisará instalar o pacote oUnit e executar testes:

opam install oUnit
dune runtest

Licença

BSD3, consulte o arquivo de licença para obter seu texto.