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

v2.0.0.tar.gz
md5=ed68e0a33325ecf6a3319cafa636d62e
sha512=425c6289d568cf697e8d9977ac43e2ebcdeec8f04f5a17225824d5a37ac700961e5d1283b92aeaebaf58ccfb5b4261bcba1180ab11c267ade0de86b68fd6ca2d

doc/ez_api.server_utils/EzAPIServerUtils/index.html

Module EzAPIServerUtilsSource

Sourcemodule StringMap : sig ... end
Sourcemodule Timings : sig ... end
Sourcemodule Directory : sig ... end
Sourcemodule Answer : sig ... end
Sourcemodule Req = EzAPI.Req
Sourcemodule File : sig ... end
Sourcemodule GMTime : sig ... end
Sourcemodule Ip : sig ... end

Server

Sourcetype server_kind =
  1. | API of Directory.t
  2. | Root of string * string option
Sourcetype 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 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 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
Sourcemodule Legacy : sig ... end
Sourceval handle : ?meth:??? -> ?content_type:??? -> ?ws:??? -> server_kind -> Req.t -> string list -> string -> [> `http of string Answer.t | `ws of 'a ] Lwt.t
Sourceval default_access_control_headers : (string * string) list
Sourceval merge_headers_with_default : (string * string) list -> (string * string) list