https://github.com/agrafix/spock-rest

DSL for defining RESTful services in Spock (WIP)
https://github.com/agrafix/spock-rest

Last synced: 8 months ago
JSON representation

DSL for defining RESTful services in Spock (WIP)

• Host: GitHub
• URL: https://github.com/agrafix/spock-rest
• Owner: agrafix
• License: mit
• Created: 2015-10-28T00:21:50.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-11-08T23:16:10.000Z (over 10 years ago)
• Last Synced: 2025-10-11T10:43:49.864Z (8 months ago)
• Language: Haskell
• Size: 145 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
Spock-rest

=====

[![Build Status](https://travis-ci.org/agrafix/Spock-rest.svg)](https://travis-ci.org/agrafix/Spock-rest)

## Intro

DSL for defining RESTful services in Spock (WIP)

## Library Usage Example

```haskell

{-# LANGUAGE GeneralizedNewtypeDeriving #-}

{-# LANGUAGE MultiParamTypeClasses      #-}

{-# LANGUAGE OverloadedStrings          #-}

module Main where

import           Data.Aeson

import           Data.HVect

import           Web.Spock.Rest

newtype Req = Req Bool

    deriving (FromJSON)

newtype Resp = Resp Bool

    deriving (ToJSON)

data SampleContentType = SampleContentType

instance ContentType SampleContentType where

    ctMimeType _ = "foo/bar"

instance ContentReader Req SampleContentType where

    crDecode _ bs =

        if bs == "42"

        then Right (Req True)

        else Left "Request has to be 42"

handleReq :: Req -> Int -> ActionCtxT ctx IO Resp

handleReq (Req i) val =

    return $ Resp $ if i then val > 0 else val < 0

main :: IO ()

main =

    runSpock 3000 $ spockT id $

    do post (SampleContentType :~> JSON :|: JSON :~> JSON :|: CtNull) ("foo" /> var) handleReq

       get (Only JSON :|: CtNull) "load" $ \() -> return $ Resp True

```

## Install

* From Source (cabal): `git clone https://github.com/agrafix/Spock-rest.git && cd Spock-rest && cabal install`

* From Source (stack): `git clone https://github.com/agrafix/Spock-rest.git && cd Spock-rest && stack build`

## Misc

### Supported GHC Versions

* 7.10.2

### License

Released under the MIT license.

2015 Alexander Thiemann