servant-js

Automatically derive javascript functions to query servant webservices. http://haskell-servant.readthedocs.org/

Version on this page:0.9.1
LTS Haskell 8.6:0.9.3
Stackage Nightly 2017-03-28:0.9.3
Latest on Hackage:0.9.3
BSD3 licensed by Servant Contributors

servant-js

servant

This library lets you derive automatically Javascript functions that let you query each endpoint of a servant webservice.

It contains a powerful system allowing you to generate functions for several frameworks (Angular, AXios, JQuery) as well as vanilla (framework-free) javascript code.

Example

Read more about the following example here.

{-# LANGUAGE DataKinds #-}
{-# LANGUAGE TypeOperators #-}
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE GeneralizedNewtypeDeriving #-}

import Control.Concurrent.STM
import Control.Monad.IO.Class
import Data.Aeson
import Data.Proxy
import GHC.Generics
import Network.Wai.Handler.Warp (run)
import Servant
import Servant.JS
import System.FilePath

-- * A simple Counter data type
newtype Counter = Counter { value :: Int }
  deriving (Generic, Show, Num)

instance ToJSON Counter

-- * Shared counter operations

-- Creating a counter that starts from 0
newCounter :: IO (TVar Counter)
newCounter = newTVarIO 0

-- Increasing the counter by 1
counterPlusOne :: MonadIO m => TVar Counter -> m Counter
counterPlusOne counter = liftIO . atomically $ do
  oldValue <- readTVar counter
  let newValue = oldValue + 1
  writeTVar counter newValue
  return newValue

currentValue :: MonadIO m => TVar Counter -> m Counter
currentValue counter = liftIO $ readTVarIO counter

-- * Our API type
type TestApi = "counter" :> Post '[JSON] Counter -- endpoint for increasing the counter
          :<|> "counter" :> Get  '[JSON] Counter -- endpoint to get the current value

type TestApi' = TestApi -- The API we want a JS handler for
           :<|> Raw     -- used for serving static files

-- this proxy only targets the proper endpoints of our API,
-- not the static file serving bit
testApi :: Proxy TestApi
testApi = Proxy

-- this proxy targets everything
testApi' :: Proxy TestApi'
testApi' = Proxy

-- * Server-side handler

-- where our static files reside
www :: FilePath
www = "examples/www"

-- defining handlers
server :: TVar Counter -> Server TestApi
server counter = counterPlusOne counter     -- (+1) on the TVar
            :<|> currentValue counter       -- read the TVar

server' :: TVar Counter -> Server TestApi'
server' counter = server counter
             :<|> serveDirectory www         -- serve static files

runServer :: TVar Counter -- ^ shared variable for the counter
          -> Int          -- ^ port the server should listen on
          -> IO ()
runServer var port = run port (serve testApi' $ server' var)

main :: IO ()
main = do
  -- write the JS code to www/api.js at startup
  writeJSForAPI testApi jquery (www </> "api.js")

  -- setup a shared counter
  cnt <- newCounter

  -- listen to requests on port 8080
  runServer cnt 8080

Changes

0.9.3

  • Remove check of responseType in vanilla backend (#13, #14)

0.9.2

  • Fix code generation for query flag (#11)
  • Improve error handling in vanilla backend (#9)

0.9.1

  • Fix javascript function name generation
  • Allow servant-0.10

0.5

  • Extract javascript-obvlious types and helpers to servant-foreign
  • Use text package instead of String
  • Provide new targets for code generation along with the old jQuery one: vanilla Javascript and Angular.js
  • Greatly simplify usage of this library by reducing down the API to just 2 functions: jsForAPI and writeJSForAPI + the choice of a code generator
  • Support for the HttpVersion, IsSecure, RemoteHost and Vault combinators
  • Remove matrix params.

0.4

  • Delete now is like Get, Post, Put, and Patch and returns a response body
  • Extend HeaderArg to support more advanced HTTP header handling (https://github.com/haskell-servant/servant-jquery/pull/6)
  • Support content-type aware combinators (but require that endpoints support JSON)
  • Add support for Matrix params (https://github.com/haskell-servant/servant-jquery/pull/11)
  • Add functions that directly generate the Javascript code from the API type without having to manually pattern match on the result.

0.2.2

  • Fix an issue where toplevel Raw endpoints would generate a JS function with no name (https://github.com/haskell-servant/servant-jquery/issues/2)
  • Replace dots by _ in paths (https://github.com/haskell-servant/servant-jquery/issues/1)
comments powered byDisqus