Module `EzResto`Source

Sourcetype meth = [

| `GET
| `POST
| `DELETE
| `PUT
| `PATCH

]

Sourcemodule Arg : sig ... end

Typed path argument.

Sourcemodule Path : sig ... end

Parametrized path to services.

Sourcemodule Query : sig ... end

Source

type ('meth, 'params, 'query, 'input, 'output, 'error) service =
  ('meth, unit, 'params, 'query, 'input, 'output, 'error)
    Resto.MakeService(Resto_json.Encoding).service

Services.

Source

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

Source

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

Source

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

Source

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

Source

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

Sourcetype 'input input =

| No_input : unit input
| Input : 'input Json_encoding.encoding -> 'input input

Sourcetype 'input request = {

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

}

Source

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

Source

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

Source

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

Source

val output_encoding : 
  ('meth, 'params, 'query, 'input, 'output, 'error) service ->
  'output Json_encoding.encoding

Source

val error_encoding : 
  ('meth, 'params, 'query, 'input, 'output, 'error) service ->
  'error Json_encoding.encoding

Sourcemodule Description = Resto.Description

Source

type description_service =
  ([ `GET ],
    unit * string list,
    Description.request,
    unit,
    Json_schema.schema Description.directory,
    unit)
    service

Source

val description_service : 
  ?description:string ->
  unit Path.path ->
  description_service

Install

Dune Dependency

Authors

Maintainers

Sources

doc/ezresto/EzResto/index.html

Module `EzResto`Source

package ezresto

Install

Dune Dependency

Authors

Maintainers

Sources

doc/ezresto/EzResto/index.html

Module EzRestoSource

Module `EzResto`Source