package ez_api
Easy API library and tools
Install
Dune Dependency
Authors
Maintainers
Sources
2.1.0.tar.gz
md5=e1d03d141ef977fbd4521256c91431f1
sha512=51b0cc4e6afb0cd5ab55c0c40964946b79e0c2cc903b5d08c594292eec723a25e25463175d704c02fe559e2af5d95973514c248a603ad28ec0230c35ad2d6492
doc/ez_api.server_utils/EzAPIServerUtils/Directory/index.html
Module EzAPIServerUtils.Directory
Source
Source
and 'a directory = {
services : 'a registered_service MethMap.t;
subdirs : 'a static_subdirectories option * 'a variable_subdirectories option;
}
Source
and _ variable_subdirectories =
| Arg : 'a1 EzAPI.Arg.t * ('a * 'a1) directory -> 'a variable_subdirectories
Source
and _ registered_service =
| Http : {
service : ('a, 'i, 'o, 'e, 's) EzAPI.Service.t;
handler : 'a -> 'i -> ('o, 'e) result Answer.t Lwt.t;
} -> 'a registered_service
| Websocket : {
service : ('a, 'i, 'o, 'e, 's) EzAPI.Service.t;
react : 'a -> 'i -> ('o, 'e) result Lwt.t;
bg : 'a -> (('o, 'e) result -> unit) -> unit Lwt.t;
onclose : ('a -> unit Lwt.t) option;
step : float option;
} -> 'a registered_service
Source
type lookup_error = [
| `Not_found
| `Cannot_parse of EzAPI.Arg.descr * string * string list
| `Method_not_allowed
]
Source
type handler_error = [
| EzEncoding.destruct_error
| `unsupported of string option
| `handler_exn of exn
| `handler_error of string
]
Source
type lookup_ok = [
| `head
| `options of (string * string) list
| `http of string -> (string Answer.t, handler_error) result Lwt.t
| `ws of (string -> (ws_frame, handler_error) result Lwt.t) * (((ws_frame, handler_error) result -> unit) -> unit Lwt.t) * (unit -> unit Lwt.t) option * float option
]
Source
val resolve :
'a. string list ->
'a directory ->
'a ->
string list ->
(resolved_directory, lookup_error) result Lwt.t
Source
val ser_websocket :
('a -> 'b -> ('c, 'd) result Lwt.t) ->
('a -> (('c, 'd) result -> 'e) -> 'f) ->
'a ->
'b EzAPI.IO.io ->
'c EzAPI.io ->
'd Json_encoding.encoding ->
(string ->
(ws_frame,
[> `destruct_exn of exn | `handler_error of string | `handler_exn of exn ])
result
Lwt.t)
* (((ws_frame, [> `handler_error of string ]) result -> 'e) ->
'f)
Source
val lookup :
?meth:[< `DELETE | `GET | `HEAD | `OPTIONS | `PATCH | `POST | `PUT ] ->
?content_type:string ->
'a directory ->
'a ->
string list ->
(lookup_ok, lookup_error) result Lwt.t
Source
val register :
'a. t ->
('a, 'b, 'c, 'd, [< EzAPI.Security.scheme ] as 'e) EzAPI.Service.t ->
(('a, 'b, 'c, 'd, 'e) EzAPI.Service.t -> 'a registered_service) ->
(t, Step.t list * conflict) result
Source
val register_http :
t ->
('a, 'b, 'c, 'd, [< EzAPI.Security.scheme ]) EzAPI.Service.t ->
('a -> 'b -> ('c, 'd) result Answer.t Lwt.t) ->
(t, Step.t list * conflict) result
Source
val register_ws :
t ->
?onclose:('a -> unit Lwt.t) ->
?step:float ->
react:('a -> 'b -> ('c, 'd) result Lwt.t) ->
bg:('a -> (('c, 'd) result -> unit) -> unit Lwt.t) ->
('a, 'b, 'c, 'd, [< EzAPI.Security.scheme ]) EzAPI.Service.t ->
(t, Step.t list * conflict) result
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>