Copyright	(c) CNRS 2017-Present
License	AGPL + CECILL v3
Maintainer	team@gargantext.org
Stability	experimental
Portability	POSIX
Safe Haskell	None
Language	Haskell2010

Gargantext.API

Description

Main (RESTful) API of the instance Gargantext.

The Garg-API is typed to derive the documentation, the mock and tests.

This API is indeed typed in order to be able to derive both the server and the client sides.

The Garg-API-Monad enables: - Security (WIP) - Features (WIP) - Database connection (long term) - In Memory stack management (short term) - Logs (WIP)

Thanks to Yann Esposito for our discussions at the start and to Nicolas Pouillard (who mainly made it).

Synopsis

data Mode
- = Dev
- | Mock
- | Prod
startGargantext :: Mode -> PortNumber -> FilePath -> IO ()
portRouteInfo :: PortNumber -> IO ()
stopGargantext :: HasNodeStorySaver env => env -> IO ()
fireWall :: Applicative f => Request -> FireWall -> f Bool
makeDevMiddleware :: Mode -> IO Middleware
makeApp :: (Typeable env, EnvC env) => env -> IO Application
api :: Proxy API
apiWithEkg :: Proxy (EkgAPI :<|> API)
apiGarg :: Proxy GargAPI

Documentation

data Mode Source #

Constructors

Dev
Mock
Prod

Instances

Instances details

Read Mode Source #
Instance details Defined in Gargantext.API Methods readsPrec :: Int -> ReadS Mode # readList :: ReadS [Mode] # readPrec :: ReadPrec Mode # readListPrec :: ReadPrec [Mode] #
Show Mode Source #
Instance details Defined in Gargantext.API Methods showsPrec :: Int -> Mode -> ShowS # show :: Mode -> String # showList :: [Mode] -> ShowS #
Generic Mode Source #
Instance details Defined in Gargantext.API Associated Types type Rep Mode :: Type -> Type # Methods from :: Mode -> Rep Mode x # to :: Rep Mode x -> Mode #
type Rep Mode Source #
Instance details Defined in Gargantext.API type Rep Mode = D1 ('MetaData "Mode" "Gargantext.API" "gargantext-0.0.4.9.5-IFz7nHafad4HfDNkPsR1x8" 'False) (C1 ('MetaCons "Dev" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Mock" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Prod" 'PrefixI 'False) (U1 :: Type -> Type)))

startGargantext :: Mode -> PortNumber -> FilePath -> IO () Source #

startGargantext takes as parameters port number and Ini file.

portRouteInfo :: PortNumber -> IO () Source #

stopGargantext :: HasNodeStorySaver env => env -> IO () Source #

fireWall :: Applicative f => Request -> FireWall -> f Bool Source #

makeDevMiddleware :: Mode -> IO Middleware Source #

makeApp :: (Typeable env, EnvC env) => env -> IO Application Source #

API Global

api :: Proxy API Source #

apiWithEkg :: Proxy (EkgAPI :<|> API) Source #

apiGarg :: Proxy GargAPI Source #