EzAPI (p.ez_api.2.1.0.doc.ez

ez_api
- Library ez_api
  - EzAPI
    - Arg
    - Url
    - Security
    - Param
    - Err
    - Meth
    - Service
    - Mime
    - Path
    - Doc
    - Error_codes
    - Req
    - IO
    - TYPES
    - Legacy
- Library ez_api.debug
  - EzDebug
- Library ez_api.debug_unix
  - EzDebug
- Library ez_api.encoding
  - EzEncoding
- Library ez_api.ezjsonm
  - Ezjsonm_interface
- Library ez_api.ezjsonm_unix
  - Ezjsonm_interface
- Library ez_api.facebook_auth
  - Facebook
- Library ez_api.google_auth
  - Google
- Library ez_api.hash
  - EzHash
- Library ez_api.iserver_default
  - EzServer
- Library ez_api.lwt_sys
  - EzLwtSys
- Library ez_api.lwt_unix
  - EzLwtSys
- Library ez_api.md5
  - EzHash
- Library ez_api.openAPI
  - EzOpenAPI
- Library ez_api.req
  - EzReq
- Library ez_api.req_default
  - EzReq
- Library ez_api.req_lwt
  - EzReq_lwt
- Library ez_api.req_lwt_default
  - EzReq_lwt
- Library ez_api.req_lwt_s
  - EzReq_lwt_S
- Library ez_api.req_s
  - EzReq_S
- Library ez_api.request
  - EzRequest
- Library ez_api.request_lwt
  - EzRequest_lwt
- Library ez_api.request_verbose
  - Verbose
- Library ez_api.sendgrid_encoding
  - EzSendgrid_encoding
  - EzSendgrid_types
- Library ez_api.sendgrid_services
  - EzSendgrid_services
- Library ez_api.server
  - EzAPIServer
- Library ez_api.server_s
  - EzServer
- Library ez_api.server_session
  - EzCookieServer
  - EzSessionServer
- Library ez_api.server_utils
  - EzAPIServerUtils
- Library ez_api.session
  - EzSession
- Library ez_api.session_client
  - EzSessionClient
- Library ez_api.ws
  - EzWs
- Library ez_api.ws_server_cohttp
  - WsCohttp
- Library ez_api.ws_server_httpaf
  - WsHttpaf
- Library ez_api.ws_types
  - EzWsCommon
- Sources

Sourcemodule Arg : sig ... end

Sourcemodule Url : sig ... end

Sourcemodule Security : sig ... end

Sourcemodule Param : sig ... end

Sourcemodule Err : sig ... end

Sourcemodule Meth : sig ... end

Sourcemodule Service : sig ... end

Sourcemodule Mime : sig ... end

Sourcemodule Path : sig ... end

Sourcemodule Doc : sig ... end

Sourcemodule Error_codes : sig ... end

Sourcemodule Req : sig ... end

Sourcemodule IO = Service.IO

Sourcemodule TYPES : sig ... end

include module type of struct include TYPES end

include module type of struct include Url.TYPES end

Sourcetype base_url = Url.TYPES.base_url =

| BASE of string

Sourcetype url = Url.TYPES.url =

| URL of string

Sourcetype param_value = TYPES.param_value =

| I of int
| S of string
| B of bool
| LS of string list

Sourcetype ip_info = TYPES.ip_info = {

ip_ip : string;
mutable ip_last : float;
mutable ip_nb : int;
ip_country : string * string;

}

Sourcetype no_security = Security.none

Sourcetype 'b io = 'b IO.io =

| Empty : unit io
| Json : 'a Json_encoding.encoding -> 'a io
| Raw : Mime.t list -> string io

Sourcetype ('args, 'input, 'output, 'error, 'security) service = {

s : ('args, 'input, 'output, 'error, 'security) Service.t;
doc : Doc.t;

}

Source

type ('output, 'error, 'security) service0 =
  (Req.t, unit, 'output, 'error, 'security) service

Source

type ('arg, 'output, 'error, 'security) service1 =
  (Req.t * 'arg, unit, 'output, 'error, 'security) service

Source

type ('arg1, 'arg2, 'output, 'error, 'security) service2 =
  ((Req.t * 'arg1) * 'arg2, unit, 'output, 'error, 'security) service

Source

type ('input, 'output, 'error, 'security) post_service0 =
  (Req.t, 'input, 'output, 'error, 'security) service

Source

type ('arg, 'input, 'output, 'error, 'security) post_service1 =
  (Req.t * 'arg, 'input, 'output, 'error, 'security) service

Source

type ('arg1, 'arg2, 'input, 'output, 'error, 'security) post_service2 =
  ((Req.t * 'arg1) * 'arg2, 'input, 'output, 'error, 'security) service

Source

type ('input, 'output, 'error, 'security) ws_service0 =
  (Req.t, 'input, 'output, 'error, 'security) service

Source

type ('arg, 'input, 'output, 'error, 'security) ws_service1 =
  (Req.t * 'arg, 'input, 'output, 'error, 'security) service

Source

type ('arg1, 'arg2, 'input, 'output, 'error, 'security) ws_service2 =
  ((Req.t * 'arg1) * 'arg2, 'input, 'output, 'error, 'security) service

Sourceval warning : string -> unit

Sourceval warnings : (string -> unit) -> unit

Source

val encode_params : 
  ('a, 'b, 'c, 'd, [< Security.scheme ]) Service.t ->
  (Param.t * param_value) list ->
  string

Source

val forge : 
  Url.base_url ->
  ('a, 'b, 'c, 'd, [< Security.scheme ]) service ->
  'a ->
  (Param.t * param_value) list ->
  Url.url

Source

val forge0 : 
  Url.base_url ->
  (Req.t, 'a, 'b, 'c, [< Security.scheme ]) service ->
  (Param.t * param_value) list ->
  Url.url

Source

val forge1 : 
  Url.base_url ->
  (Req.t * 'a, 'b, 'c, 'd, [< Security.scheme ]) service ->
  'a ->
  (Param.t * param_value) list ->
  Url.url

Source

val forge2 : 
  Url.base_url ->
  ((Req.t * 'a) * 'b, 'c, 'd, 'e, [< Security.scheme ]) service ->
  'a ->
  'b ->
  (Param.t * param_value) list ->
  Url.url

Source

val raw_service : 
  'i. ?section:??? ->
  ?name:??? ->
  ?descr:??? ->
  ?meth:??? ->
  input:'i io ->
  output:'o io ->
  ?errors:??? ->
  ?params:??? ->
  ?security:??? ->
  ?access_control:??? ->
  ?register:??? ->
  ?hide:??? ->
  ?input_example:??? ->
  ?output_example:??? ->
  (Req.t, 'a) Path.t ->
  ('a, 'i, 'o, 'e, 'b) service

Source

val post_service : 
  ?section:??? ->
  ?name:??? ->
  ?descr:??? ->
  ?meth:??? ->
  input:'a Json_encoding.encoding ->
  output:'b Json_encoding.encoding ->
  ?errors:??? ->
  ?params:??? ->
  ?security:??? ->
  ?register:??? ->
  ?access_control:??? ->
  ?input_example:??? ->
  ?output_example:??? ->
  (Req.t, 'e) Path.t ->
  ('e, 'a, 'b, 'c, 'd) service

Source

val service : 
  ?section:??? ->
  ?name:??? ->
  ?descr:??? ->
  ?meth:??? ->
  output:'a Json_encoding.encoding ->
  ?errors:??? ->
  ?params:??? ->
  ?security:??? ->
  ?access_control:??? ->
  ?register:??? ->
  ?output_example:??? ->
  (Req.t, 'd) Path.t ->
  ('d, unit, 'a, 'b, 'c) service

Source

val ws_service : 
  ?section:??? ->
  ?name:??? ->
  ?descr:??? ->
  input:'a io ->
  output:'b io ->
  ?errors:??? ->
  ?params:??? ->
  ?security:??? ->
  ?access_control:??? ->
  ?register:??? ->
  ?output_example:??? ->
  (Req.t, 'e) Path.t ->
  ('e, 'a, 'b, 'c, 'd) service

Source

val register : 
  ('a, 'b, 'c, 'd, [< Security.scheme ] as 'e) service ->
  ('a, 'b, 'c, 'd, 'e) Service.t

Sourceval id : ('a, 'b, 'c, 'd, [< Security.scheme ]) service -> int

Sourcemodule Legacy : sig ... end