package terminus-hlc

Not available on OCaml 5.5
  1. Overview
  2. Docs
Terminus with the http-lwt-client request handler

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (1)

Authors

  1. É
    Étienne Marais <etienne@maiste.fr>

Maintainers

  1. É
    Étienne Marais <etienne@maiste.fr>

Sources

terminus-0.1.0.tbz
sha256=6a31c14c76eefa30189206d670797356bfee4cbb869a06b7017cbb19f601505b
sha512=1ef7f6f25681a84bac90dc8c0c673bc22ec8651139c3672b32857ab9c4c61cfe4fbc8d37c195f31e480df23867ff5c2dcfb8135b8a7f70a55c10fe0825837b04

Description

Terminus-hlc is an implementation of the Terminus specifications using http-lwt-client.

Added to opam-repository:

README

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)

  1. terminus
  2. http-lwt-client < "0.1.0"
  3. dune >= "3.0"

Dev Dependencies (4)

  1. odoc with-doc
  2. alcotest-lwt with-test
  3. alcotest with-test
  4. httpaf-lwt-unix with-test

Optional Dependencies

None

Used by

None

Conflicts (1)

  1. result < "1.5"

Build status

Results of building terminus-hlc 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.1.0 (this version) good good n/a n/a n/a
  • 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