package ez_api

  1. Overview
  2. Docs
Easy API library and tools

Install 

dune-project
 Dependency

github.com Readme Changelog LGPL-2.1-only 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

3.0.0.tar.gz
md5=9069f59ac83c958cedc90a25f24faa1e
sha512=4b066a759043e6704a9617bdc412d29f7ded058cb0e01eb3a8207f54b80bebb478bb98a96832e61b15d281bc8f132e1386459c563eb807a51c01324541fe28b2

doc/ez_api.server_utils/EzAPIServerUtils/index.html

Module EzAPIServerUtilsSource

module Timings = Timings
Sourcemodule Directory : sig ... end
module Answer = Answer
module Req = EzAPI.Req
module GMTime = GMTime
module Ip = Ip
module Cors = Cors

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

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, Dir_types.Step.t list * Dir_types.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, Dir_types.Step.t list * Dir_types.conflict) result
Sourceexception Conflict of Dir_types.Step.t list * Dir_types.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:??? -> ?allow_origin:??? -> file: (?meth:??? -> ?default:??? -> string -> string list -> string Answer.t Lwt.t) -> printf: ((string -> string -> unit Lwt.t, Format.formatter, unit, unit Lwt.t) format4 -> string -> string -> unit Lwt.t) -> server_kind -> Req.t -> string list -> string -> [> `http of string Answer.t | `ws of 'b ] Lwt.t