chakra: A REST Web Api server template for building (micro)services.

[ library, mit, program, web ] [ Propose Tags ]

A REST Web Api server template, that serves as a reference and avoids repetive boilerplate when building many (micro)services. This combines best libraries available in Haskell web development, like RIO, warp, servant, etc., and principles around 12-factor app.

Check Chakra module documentation for example.

Idea is to provide Curated & Opinionated set of packages and patterns to build well designed web api applications in Haskell.

Inspiration from Python Flask, ASP.NET Core

For more details, please see the README on Github at https://github.com/cackharot/haskell-web-api-template#readme


[Skip to Readme]
Versions [faq] 0.1.0
Dependencies aeson, ansi-terminal, base (>=4.11 && <10), bytestring, chakra, cryptonite, data-default, data-has, dotenv, envy, fast-logger, http-types, iproute, jose, lens, mtl, network, network-uri, options, optparse-simple, prometheus-client, prometheus-metrics-ghc, rio, servant-auth (>=0.4.0.0), servant-auth-server (>=0.4.6.0), servant-server (>=0.18.2), streaming-commons, string-conversions, text, time, transformers, unordered-containers, wai, wai-cli, wai-extra, wai-middleware-prometheus, warp [details]
License MIT
Copyright 2020 Cackharot
Author Cackharot
Maintainer cackharot@gmail.com
Category Web
Home page https://github.com/cackharot/haskell-web-api-template#readme
Bug tracker https://github.com/cackharot/haskell-web-api-template/issues
Source repo head: git clone https://github.com/cackharot/haskell-web-api-template
Uploaded by cackharot at 2021-01-16T22:16:09Z
Distributions NixOS:0.1.0
Executables chakra-exe
Downloads 30 total (5 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2021-01-16 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for chakra-0.1.0

[back to package description]

Chakra :: Web Api Template

Hackage Build Status Hackage Deps

A REST web api server template in Haskell.

This serves as a base to create API projects that comes with the following features to avoid repeated bolierplate in each one.

  • Light weight & super fast Warp http server
  • Supports HTTP 1.1 & HTTP/2 TLS by warp
  • JSON as input/output serialization using Aeson library
  • Structured logging (JSON) both application & HTTP request
  • Define the REST interface using Servant library
  • JWT (Bearer) token based authentication
  • Application config via ENVIRONMENT variables (via dotenv & envy)
  • Health & Info endpoints
  • Prometheus metrics endpoint

TODO

  • [x] Integrate with RIO
  • [x] Integrate with Servant
  • [x] Integrate with FastLogger
  • [x] Integrate with doenv & envy
  • [x] Integrate with Prometheus
  • [x] Integrate with wai-util
  • [x] Setup JWT Authentication
  • [x] JSON Error formatting
  • [x] Setup HTTPS
  • [ ] Setup PSQL/SqlLite pool with Presistent
  • [x] Setup Stack template

Getting started

To create a bare minimum API service all you need is below:

#!/usr/bin/env stack
{- stack --resolver lts-14.27 runghc
 --package chakra
-}
{-# LANGUAGE NoImplicitPrelude, OverloadedStrings, UnicodeSyntax, DataKinds, TypeOperators #-}
import RIO
import Chakra
import Servant

type HelloRoute = "hello" :> QueryParam "name" Text :> Get '[PlainText] Text
type API = HelloRoute :<|> EmptyAPI

hello :: Maybe Text -> BasicApp Text
hello name = do
  let name' = fromMaybe "Sensei!" name
  logInfo $ "Saying hello to " <> display name'
  return $ "Hello " <> name' <> "!"

main :: IO ()
main = do
  let infoDetail = InfoDetail "example" "dev" "0.1" "change me"
      appEnv = appEnvironment infoDetail
      appVer = appVersion infoDetail
      appAPI = Proxy :: Proxy API
      appServer = hello :<|> emptyServer
  logFunc <- buildLogger appEnv appVer
  middlewares <- chakraMiddlewares infoDetail
  runChakraAppWithMetrics
    middlewares
    EmptyContext
    (logFunc, infoDetail)
    appAPI
    appServer

Usage

Add this package to your application and refer examples directory for inspiration.

# Create a new haskell app using stack's rio template
stack new UserApi rio

Edit the below files to include the dependencies

# Stack package.yaml
dependencies:
- base >= 4.11 && < 10
- chakra
- rio
- servant-server

# stack.yaml
resolver: lts-14.27
packages:
- .
extra-deps:
- git: https://github.com/cackharot/haskell-web-api-template.git
  commit: 70425ea54e4bc117582cdc0495f2b88827dbbf52
- prometheus-metrics-ghc-1.0.1.1
- wai-middleware-prometheus-1.0.0
- servant-auth-0.4.0.0
- servant-auth-server-0.4.6.0
- servant-server-0.18.2
- servant-0.18.2

A stack project template is also available for bootstraping quickly

stack new UserApi https://raw.githubusercontent.com/cackharot/haskell-web-api-template/main/chakra.hsfiles

Build & Run

make build
PORT=3000 make run

open http://localhost:3000/health

Endpoints

Info: http://localhost:3000/info

Health: http://localhost:3000/health

Metrics: http://localhost:3000/metrics

Run tests

make test

HTTPS Setup

Generate RootCA & localhost Public & Private key pair

Be sure to edit certs/domains.ext file if you need more DNS aliases before executing these commands.

openssl req -x509 -nodes -new -sha256 -days 1024 -newkey rsa:2048 -keyout "certs/RootCA.key" -out "certs/RootCA.pem" -subj "/C=US/CN=Localhost-Root-CA"
openssl x509 -outform pem -in "certs/RootCA.pem" -out "certs/RootCA.crt"

openssl req -new -nodes -newkey rsa:2048 -keyout "certs/localhost.key" -out "certs/localhost.csr" -subj "/C=US/ST=NoWhere/L=NoWhere/O=Localhost-Certificates/CN=localhost.local"
openssl x509 -req -sha256 -days 1024 -in "certs/localhost.csr" -CA "certs/RootCA.pem" -CAkey "certs/RootCA.key" -CAcreateserial -extfile "certs/domains.ext" -out "certs/localhost.crt"

Once you have these keys then to start the server in https run the below command:

/path/to/urapiexec --port 3443 --protocol http+tls --tlskey certs/localhost.key --tlscert certs/localhost.crt

open https://localhost:3443/health

JWT Authentication

This template supports only authentication against standard JWT issued by Azure, Okta, Keybase & other OAuth JWT authentication providers. However its easily customizable to authenticate against custom issued JWT token. This template does not issue a JWT token.

The validate any incoming JWT's we need the public keys (provider by JWT issuer) to verify the payload and also need to verify the audiences. These are configurable via ENV variables

JWK_PATH="secrets/jwk.sig"
JWK_AUDIENCES="api://some-resource-id"