OpenAPI Bindings to OryKratos

The library in lib provides bindings to the OryKratos API.

Installation

Just add ory-kratos to your dependencies

Main Interface

The main interface to this library is in the OryKratos.API module, which exports the OryKratosBackend type. The OryKratosBackend type can be used to create and define servers and clients for the API.

Creating a Client

A client can be created via the createOryKratosClient function, which will generate a function for every endpoint of the API. Then these functions can be invoked with runOryKratosClientWithManager or more conveniently with callOryKratosClient (depending if you want an Either back or you want to catch) to access the API endpoint they refer to, if the API is served at the url you specified.

For example, if localhost:8080 is serving the OryKratos API, you can write:

{-# LANGUAGE RecordWildCards #-}

import OryKratos.API as API

import           Network.HTTP.Client     (newManager)
import           Network.HTTP.Client.TLS (tlsManagerSettings)
import           Servant.Client          (ClientEnv, mkClientEnv, parseBaseUrl)


main :: IO ()
main = do
  -- Configure the BaseUrl for the client
  url <- parseBaseUrl "http://localhost:8080/"

  -- You probably want to reuse the Manager across calls, for performance reasons
  manager <- newManager tlsManagerSettings

  -- Create the client (all endpoint functions will be available)
  OryKratosBackend{..} <- API.createOryKratosClient

  -- Any OryKratos API call can go here, e.g. here we call `getSomeEndpoint`
  API.callOryKratos (mkClientEnv manager url) getSomeEndpoint

Creating a Server

In order to create a server, you must use the runOryKratosMiddlewareServer function. However, you unlike the client, in which case you got a OryKratosBackend from the library, you must instead provide a OryKratosBackend. For example, if you have defined handler functions for all the functions in OryKratos.Handlers, you can write:

{-# LANGUAGE RecordWildCards #-}

import OryKratos.API
-- required dependency: wai
import Network.Wai (Middleware)
-- required dependency: wai-extra
import Network.Wai.Middleware.RequestLogger (logStdout)

-- A module you wrote yourself, containing all handlers needed for the OryKratosBackend type.
import OryKratos.Handlers

-- If you would like to not use any middlewares you could use runOryKratosServer instead

-- Combined middlewares
requestMiddlewares :: Middleware
requestMiddlewares = logStdout

-- Run a OryKratos server on localhost:8080
main :: IO ()
main = do
  let server = OryKratosBackend{..}
      config = Config "http://localhost:8080/"
  runOryKratosMiddlewareServer config requestMiddlewares server