package ez_api

You can search for identifiers within the package.

in-package search v0.2.0

package ez_api

ez_api
- EzAPI
  - Arg
    
    Ty
    
    Ty
  - Doc
  - Err
    
    IntMap
  - Error_codes
  - Legacy
  - Meth
  - Mime
  - Param
  - Path
  - Req
    
    StringMap
  - Security
    
    StringSet
  - Service
    
    IO
  - TYPES
  - Url
    
    TYPES
ez_api.blake2s
- EzHash
ez_api.cohttp
- EzCohttp
  - Base
  - Interface
  - Legacy
ez_api.cohttp_base
- EzCohttp_base
  - Make
    
    Client
ez_api.cohttp_lwt
- EzCohttp_lwt
  - Base
  - Interface
  - Legacy
ez_api.debug_unix
- EzDebug
ez_api.encoding
- EzEncoding
  - Ezjsonm
ez_api.ezjsonm_unix
- Ezjsonm_interface
ez_api.facebook_auth
- Facebook
  - Encoding
  - Services
  - Types
ez_api.google_auth
- Google
  - Encoding
  - Services
  - Types
ez_api.icohttp
- EzReq
  - Interface
  - Legacy
ez_api.icohttp_lwt
- EzReq_lwt
  - Interface
  - Legacy
ez_api.iserver_cohttp
- EzServer
ez_api.iserver_default
- EzServer
ez_api.loads_offset
- EzLoads_offset
ez_api.lwt_unix
- EzLwtSys
ez_api.md5
- EzHash
ez_api.openAPI
- EzOpenAPI
  - Encoding
  - Makers
  - Types
ez_api.ppx_common
- Ppx_common
ez_api.req_default
- EzReq
  - Interface
  - Legacy
ez_api.req_lwt_default
- EzReq_lwt
  - Interface
  - Legacy
ez_api.request
- EzRequest
  - ANY
    
    Legacy
  - Make
    
    Legacy
    
    _
ez_api.request_lwt
- EzRequest_lwt
  - ANY
    
    Legacy
  - Make
    
    Legacy
    
    _
ez_api.request_verbose
- Verbose
ez_api.sendgrid_encoding
- EzSendgrid_encoding
- EzSendgrid_types
ez_api.sendgrid_services
- EzSendgrid_services
ez_api.server
- EzAPIServer
ez_api.server_cohttp
- EzAPIServerCohttp
ez_api.server_session
- EzCookieServer
- EzSessionServer
  - Arg
    
    SessionArg
    
    SessionStore
  - Make
    
    S
    
    SessionArg
    
    SessionStore
    
    Service
  - SessionStore
  - SessionStoreInMemory
  - UserStoreInMemory
    
    S
    
    SessionArg
    
    SessionStore
ez_api.server_utils
- EzAPIServerUtils
  - Answer
  - Directory
    
    MethMap
    
    Step
    
    StringMap
  - File
    
    FileString
  - GMTime
  - Ip
  - Legacy
  - StringMap
  - Timings
ez_api.session
- EzSession
  - Hash
  - M
  - Make
    
    Encoding
    
    S
    
    Service
  - TYPES
    
    SessionArg
ez_api.session_client
- EzSessionClient
  - Make
    
    S
    
    Service
    
    _
    
    Legacy
ez_api.sha2
- EzHash
ez_api.sha3
- EzHash
ez_api.ws_server_cohttp
- WsCohttp
ez_api.ws_server_httpaf
- WsHttpaf
ez_api.ws_types
- EzWsCommon
  - S
  - Types

Legend:
Library
Module
Module type
Parameter
Class
Class type

type user_id

User identifier, which generally is the same as login

type user_info

Associated to user information

val web_host : string option

Web host, that should be used in access control headers, if specified. If web_host isn't specified, then acces-control header in response will be set to '*' and authentication wwith cookies wouldn't work. Note : Cookies would be set by browser only if request's flag 'with_credentials' is set to true. Last one in turn, requires that "Access-control_allow_origin" header by reponse returns something different from "*".

val user_id_encoding : user_id Json_encoding.encoding

Json encoding for user's id

val user_info_encoding : user_info Json_encoding.encoding

Json encoding for user's information

val rpc_path : string list

RPC path where authentication services like connect, login and logout would be placed.

val token_kind : [ `Cookie of string * int64 option | `CSRF of string ]

Describes two ways to store a token within a client request :

Stores as a cookie associated with the given cookie name and its max-age, if provided.
Stores as a CSRF header with the given name.