linnet: Lightweight library for building HTTP API

[ library, linnet ] [ Propose Tags ]

Please see the documentation at http://linnet.io


[Skip to Readme]
Versions [faq] 0.1.0.0, 0.1.0.1, 0.1.0.2, 0.2.0.0, 0.3.0.0, 0.4.0.0, 0.4.0.1
Dependencies base (>=4.7 && <5), bytestring (>=0.10.8.2), bytestring-conversion (>=0.3.1), case-insensitive (>=1.2.0.11), either (>=5.0.1.1), exceptions (>=0.10.3), http-media (>=0.8.0.0), http-types (>=0.12.3), mtl (>=2.2.2), text (>=1.2.3.1), time (>=1.8.0.2), transformers (>=0.5.6.2), uri-encode (>=1.5.0.5), wai (>=3.2.2.1), warp (>=3.2.28) [details]
License LicenseRef-Apache
Copyright 2019 Sergey Kolbasov
Author Sergey Kolbasov
Maintainer whoisliar@gmail.com
Category linnet
Home page https://github.com/haskell-linnet/linnet#readme
Bug tracker https://github.com/haskell-linnet/linnet/issues
Source repo head: git clone https://github.com/haskell-linnet/linnet
Uploaded by sergeykolbasov at Wed Sep 18 20:36:32 UTC 2019
Distributions NixOS:0.4.0.1
Downloads 250 total (231 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2019-09-18 [all 1 reports]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees


Readme for linnet-0.4.0.1

[back to package description]

Linnet

Linnet [ˈlɪnɪt] is a lightweight Haskell library for building HTTP API on top of WAI. Library design is heavily inspired by Scala Finch.

Check out linnet.io for documentation.

Badges

Travis (.com) branch Gitter Hackage

Hello world

Here is an example of running simple application using Warp server:

{-# LANGUAGE FlexibleInstances      #-}
{-# LANGUAGE MultiParamTypeClasses  #-}
{-# LANGUAGE OverloadedStrings      #-}
{-# LANGUAGE TypeApplications       #-}
{-# LANGUAGE TypeSynonymInstances   #-}

import Control.Exception (SomeException)
import Data.Function     ((&))
import Data.Text         (Text, append)
import Linnet
import Network.Wai       (Application)

-- Linnet makes no assumption on how to encode exceptions.
-- It's necessary to define encoder of exceptions for used content-types.
-- Here it returns no content
instance Encode TextPlain SomeException where
  encode _ = mempty

helloName :: Endpoint IO Text
helloName = get(p' "hello" // path @Text) ~>>
               (\name -> return $ ok ("Hello, " `append` name))

app :: Application
app = bootstrap @TextPlain helloName & compile & toApp

main :: IO ()
main = run 9000 app

Now try to call your application with:

curl -v http://localhost:9000/hello/linnet

Maintainers

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this software except in compliance with the License.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.