Module `Resto.MakeService`Source

Services.

Parameters

module Encoding : ENCODING

Signature

Sourcetype (+'meth, 'prefix, 'params, 'query, 'input, 'output, 'error) t constraint 'meth = [< meth ]

type (+'meth, 'prefix, 'params, 'query, 'input, 'output, 'error) service =
  ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) t

Source

val meth : 
  ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) service ->
  'meth

Source

val query : 
  ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) service ->
  'query Query.t

Sourcetype _ input =

| No_input : unit input
| Input : 'input Encoding.t -> 'input input

Source

val input_encoding : 
  ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) service ->
  'input input

Source

val output_encoding : 
  ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) service ->
  'output Encoding.t

Source

val error_encoding : 
  ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) service ->
  'error Encoding.t

Source

val get_service : 
  ?description:string ->
  query:'query Query.t ->
  output:'output Encoding.t ->
  error:'error Encoding.t ->
  ('prefix, 'params) Path.t ->
  ([ `GET ], 'prefix, 'params, 'query, unit, 'output, 'error) service

get_service ?description ~query ~output ~error path is a GET service that is intended to seat at the URI described by path and receive the additional parameters described by query. The value output (resp. error) describe the representation of the successful (resp. failed) returned value for the service.

Note that, whilst get_service declares a service, the resulting service is not registered yet. This is handled in Resto_directory.

post_service, delete_service, put_service, and patch_service are similar to get_service but for the other HTTP methods.

Note that some of these functions take an additional input argument. This is only for the services with methods that expect additional parameters. It is used internally to encode/decode additional parameters passed in a dedicated payload rather than in the path/query parameters.

Source

val post_service : 
  ?description:string ->
  query:'query Query.t ->
  input:'input Encoding.t ->
  output:'output Encoding.t ->
  error:'error Encoding.t ->
  ('prefix, 'params) Path.t ->
  ([ `POST ], 'prefix, 'params, 'query, 'input, 'output, 'error) service

Source

val delete_service : 
  ?description:string ->
  query:'query Query.t ->
  output:'output Encoding.t ->
  error:'error Encoding.t ->
  ('prefix, 'params) Path.t ->
  ([ `DELETE ], 'prefix, 'params, 'query, unit, 'output, 'error) service

Source

val patch_service : 
  ?description:string ->
  query:'query Query.t ->
  input:'input Encoding.t ->
  output:'output Encoding.t ->
  error:'error Encoding.t ->
  ('prefix, 'params) Path.t ->
  ([ `PATCH ], 'prefix, 'params, 'query, 'input, 'output, 'error) service

Source

val put_service : 
  ?description:string ->
  query:'query Query.t ->
  input:'input Encoding.t ->
  output:'output Encoding.t ->
  error:'error Encoding.t ->
  ('prefix, 'params) Path.t ->
  ([ `PUT ], 'prefix, 'params, 'query, 'input, 'output, 'error) service

Source

val prefix : 
  ('prefix, 'inner_prefix) Path.t ->
  ('meth, 'inner_prefix, 'params, 'query, 'input, 'output, 'error) service ->
  ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) service

Source

val subst0 : 
  ([< meth ] as 'm, 'p, 'p, 'q, 'i, 'o, 'e) service ->
  ('m, 'p2, 'p2, 'q, 'i, 'o, 'e) service

Source

val subst1 : 
  ([< meth ] as 'm, 'p, 'p * 'a, 'q, 'i, 'o, 'e) service ->
  ('m, 'p2, 'p2 * 'a, 'q, 'i, 'o, 'e) service

Source

val subst2 : 
  ([< meth ] as 'm, 'p, ('p * 'a) * 'b, 'q, 'i, 'o, 'e) service ->
  ('m, 'p2, ('p2 * 'a) * 'b, 'q, 'i, 'o, 'e) service

Source

val subst3 : 
  ([< meth ] as 'm, 'p, (('p * 'a) * 'b) * 'c, 'q, 'i, 'o, 'e) service ->
  ('m, 'p2, (('p2 * 'a) * 'b) * 'c, 'q, 'i, 'o, 'e) service

Source

type ('prefix, 'params, 'error) description_service =
  ([ `GET ],
    'prefix,
    'params * string list,
    Description.request,
    unit,
    Encoding.schema Description.directory,
    'error)
    service

Source

val description_service : 
  ?description:string ->
  'error Encoding.t ->
  ('prefix, 'params) Path.t ->
  ('prefix, 'params, 'error) description_service

Sourcetype 'input request = {

meth : meth;
uri : Uri.t;
input : 'input input;

}

Source

val forge_request : 
  ('meth, unit, 'params, 'query, 'input, 'output, 'error) service ->
  ?base:Uri.t ->
  'params ->
  'query ->
  'input request

Source

val forge_partial_request : 
  ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) service ->
  ?base:Uri.t ->
  'params ->
  'query ->
  'input request

Sourcemodule Internal : sig ... end

package resto

Module Resto.MakeServiceSource

Parameters

Signature

Module `Resto.MakeService`Source