5b50279851
The new version of ocplib-resto : - uses jbuilder ; - is functorized over `Json_encoding` rather than `Json_repr` ; - handles query parameters ; - handles HTTP methods (GET, POST, DELETE, PUT, PATCH) ; - replaces `custom_service` by a more generic trailer argument ; - replaces generic answer `(code, body)` by a more ad-hoc sum type (allowing distinct encoding for success and error) ; - includes a minimal HTTP-server based on Cohttp (includings CORS and media type negotiation). - adds a function `Directory.transparent_lookup` to lookup/call a service handler without serializing the various parameters (path, query, request body). As a first consequences in Tezos, this patch allows binary communication between the client and the node. This patch tries to be minimal inside the tezos source code and therefore it introduces a minimal compatibility layer in `RPC.ml`. This code should be removed as soon as possible.
72 lines
2.5 KiB
OCaml
72 lines
2.5 KiB
OCaml
(**************************************************************************)
|
|
(* *)
|
|
(* Copyright (c) 2014 - 2017. *)
|
|
(* Dynamic Ledger Solutions, Inc. <contact@tezos.com> *)
|
|
(* *)
|
|
(* All rights reserved. No warranty, explicit or implicit, provided. *)
|
|
(* *)
|
|
(**************************************************************************)
|
|
|
|
(** Typed RPC services: definition, binding and dispatch. *)
|
|
|
|
|
|
module Data : Resto.ENCODING with type 'a t = 'a Data_encoding.t
|
|
and type schema = Data_encoding.json_schema
|
|
|
|
include (module type of struct include Resto end)
|
|
include (module type of struct include RestoDirectory end)
|
|
module Directory : (module type of struct include RestoDirectory.MakeDirectory(Data) end)
|
|
module Service : (module type of struct include Directory.Service end)
|
|
|
|
(** Compatibility layer, to be removed ASAP. *)
|
|
|
|
type 'a directory = 'a Directory.t
|
|
type ('prefix, 'params, 'input, 'output) service =
|
|
([ `POST ], 'prefix, 'params, unit, 'input, 'output, unit) Service.t
|
|
|
|
val service:
|
|
?description: string ->
|
|
input: 'input Data_encoding.t ->
|
|
output: 'output Data_encoding.t ->
|
|
('prefix, 'params) Path.t ->
|
|
('prefix, 'params, 'input, 'output) service
|
|
|
|
type directory_descr = Data_encoding.json_schema Description.directory
|
|
|
|
val empty: 'a directory
|
|
val register:
|
|
'prefix directory ->
|
|
('prefix, 'params, 'input, 'output) service ->
|
|
('params -> 'input -> [< ('output, unit) RestoDirectory.Answer.t ] Lwt.t) ->
|
|
'prefix directory
|
|
|
|
val register0:
|
|
unit directory ->
|
|
(unit, unit, 'i, 'o) service ->
|
|
('i -> [< ('o, unit) Answer.t ] Lwt.t) ->
|
|
unit directory
|
|
|
|
val register1:
|
|
'prefix directory ->
|
|
('prefix, unit * 'a, 'i, 'o) service ->
|
|
('a -> 'i -> [< ('o, unit) Answer.t ] Lwt.t) ->
|
|
'prefix directory
|
|
|
|
val register2:
|
|
'prefix directory ->
|
|
('prefix, (unit * 'a) * 'b, 'i, 'o) service ->
|
|
('a -> 'b -> 'i -> [< ('o, unit) Answer.t ] Lwt.t) ->
|
|
'prefix directory
|
|
|
|
val register_dynamic_directory1:
|
|
?descr:string ->
|
|
'prefix directory ->
|
|
('prefix, unit * 'a) Path.path ->
|
|
('a -> (unit * 'a) directory Lwt.t) ->
|
|
'prefix directory
|
|
|
|
val forge_request:
|
|
(unit, 'params, 'input, _) service ->
|
|
'params -> 'input -> MethMap.key * string list * Data_encoding.json
|
|
|