package terminus-hlc
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=6a31c14c76eefa30189206d670797356bfee4cbb869a06b7017cbb19f601505b
sha512=1ef7f6f25681a84bac90dc8c0c673bc22ec8651139c3672b32857ab9c4c61cfe4fbc8d37c195f31e480df23867ff5c2dcfb8135b8a7f70a55c10fe0825837b04
Description
Terminus-hlc is an implementation of the Terminus specifications using http-lwt-client.
Published: 04 Aug 2022
README
README.md
Terminus
Another Rest API http client manager, written in OCaml
About
This package gives a specification about a REST API Backend to execute requests to a web API using JSON format to interact with. terminus also gives implementations of this specification with different ocaml http client. It was first written as a part of the equinoxe package but, as I tend to use it more other projects, it seems a good idea to extract it as a package itself.
:warning: Be aware that this is still an under development package. The API can change regularly until there is a fix version of the API.
Getting started
Installation
To install a dev version of Terminus, you can install it via pinning:
$ opam pin add terminus.dev https://github.com/maiste/terminus.git
Usage
Terminus contains two types of modules. The first one is the Terminus module which contains the specifications for an REST API backend. The other ones are Terminus-* which implement this specification with an ocaml http client.
Documentation
API documentation can be found online on the project GitHub Pages
Dependencies (3)
- terminus
-
http-lwt-client
< "0.1.0" -
dune
>= "3.0"
Dev Dependencies (4)
-
odoc
with-doc -
alcotest-lwt
with-test -
alcotest
with-test -
httpaf-lwt-unix
with-test
Used by
None
Conflicts (1)
-
result
< "1.5"