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
- 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
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 #
makeDevMiddleware :: Mode -> IO Middleware Source #
apiWithEkg :: Proxy (EkgAPI :<|> API) Source #