package ez_api

  1. Overview
  2. Docs
Easy API library and tools

Install 

dune-project
 Dependency

github.com Readme Changelog LGPL-2.1-only WITH OCaml-LGPL-linking-exception License Edit opam file Versions (8)

Authors

  1. C
    Cagdas Bozman <cagdas.bozman@ocamlpro.com>
  2. M
    Michael Laporte <michael.laporte@ocamlpro.com>
  3. F
    Fabrice Le Fessant <fabrice.le_fessant@ocamlpro.com>
  4. M
    Maxime Levillain <maxime.levillain@ocamlpro.com>
  5. A
    Alain Mebsout <alain.mebsout@ocamlpro.com>

Maintainers

  1. F
    Fabrice Le Fessant <fabrice.le_fessant@ocamlpro.com>

Sources

1.2.0.tar.gz
md5=55bb40d00db6cd35cbf6ef6cff63363a
sha512=16922b231f19615ca7179a3c7d31e8c3897f2b37f574f69e06b35f12b501434c6eb85bec91cfed16ffd3eec71f8859d94bd003044a848560d434e04a0b1e99e2

doc/ez_api.server/EzAPIServer/index.html

Module EzAPIServerSource

include module type of struct include EzServer end
val server : ?catch:(string -> exn -> string EzAPIServerUtils.Answer.t Lwt.t) -> (int * EzAPIServerUtils.server_kind) list -> unit Lwt.t
val set_debug : unit -> unit
include module type of struct include EzAPIServerUtils end

Server

Sourcetype server_kind = EzAPIServerUtils.server_kind =
  1. | API of Directory.t
  2. | Root of string * string option
Sourcetype server = EzAPIServerUtils.server = {
  1. server_port : int;
  2. server_kind : server_kind;
}

Utils

Sourceval return : ?code:??? -> ?headers:??? -> 'a -> 'a Answer.t Lwt.t
Sourceval return_ok : ?code:??? -> ?headers:??? -> 'a -> ('a, 'b) result Answer.t Lwt.t
Sourceval return_error : ?content:??? -> ?headers:??? -> int -> ('b, 'a option) result Answer.t Lwt.t
Sourceval verbose : int ref
Sourceval set_verbose : int -> unit
Sourceval pp_time : unit -> string
Sourceval debug : ?v:??? -> ('a, unit, string, unit) format4 -> 'a
Sourceval debugf : ?v:??? -> (unit -> unit) -> unit

Register Handler

Sourceval register_res : ('a, 'b, 'c, 'd, [< EzAPI.Security.scheme ] as 'e) EzAPI.service -> ('a -> 'e list -> 'b -> ('c, 'd) result EzAPIServerUtils.Answer.t Lwt.t) -> Directory.t -> (Directory.t, Directory.Step.t list * Directory.conflict) result
Sourceval register_ws_res : ('a, 'b, 'c, 'd, [< EzAPI.Security.scheme ] as 'e) EzAPI.service -> react:('a -> 'e list -> 'b -> ('c, 'd) result Lwt.t) -> bg:('a -> 'e list -> (('c, 'd) result -> unit) -> unit Lwt.t) -> ?onclose:??? -> ?step:??? -> Directory.t -> (Directory.t, Directory.Step.t list * Directory.conflict) result
Sourceexception Conflict of Directory.Step.t list * Directory.conflict
Sourceval register : ('a, 'b, 'c, 'd, [< EzAPI.Security.scheme ] as 'e) EzAPI.service -> ('a -> 'e list -> 'b -> ('c, 'd) result EzAPIServerUtils.Answer.t Lwt.t) -> Directory.t -> Directory.t
Sourceval register_ws : ('a, 'b, 'c, 'd, [< EzAPI.Security.scheme ] as 'e) EzAPI.service -> ?onclose:??? -> ?step:??? -> react:('a -> 'e list -> 'b -> ('c, 'd) result Lwt.t) -> bg:('a -> 'e list -> (('c, 'd) result -> unit) -> unit Lwt.t) -> Directory.t -> Directory.t
Sourceval handle : ?meth:??? -> ?content_type:??? -> ?ws:??? -> server_kind -> Req.t -> string list -> string -> [> `http of string EzAPIServerUtils.Answer.t | `ws of 'a ] Lwt.t
Sourceval access_control_headers : (string * string) list