Moduleservant-server-0.20.2Haskell2010

Servant.Server.StaticFiles

This module defines server-side handlers that lets you serve static files.

The most common needs for a web application are covered by serveDirectoryWebApp, but the other variants allow you to use different StaticSettings and serveDirectoryWith even allows you to specify arbitrary StaticSettings to be used for serving static files.

6 values

Packageservant-server-0.20.2
Exports6
LanguageHaskell2010
LicenceBSD-3-Clause
SourceStaticFiles.hs

valueserveDirectoryWebApp :: FilePath -> ServerT Raw m

Serve anything under the specified directory as a Raw endpoint.

type MyApi = "static" :> Raw

server :: Server MyApi
server = serveDirectoryWebApp "/var/www"

would capture any request to /static/<something> and look for <something> under /var/www.

It will do its best to guess the MIME type for that file, based on the extension, and send an appropriate Content-Type header if possible.

If your goal is to serve HTML, CSS and Javascript files that use the rest of the API as a webapp backend, you will most likely not want the static files to be hidden behind a /static/ prefix. In that case, remember to put the serveDirectoryWebApp handler in the last position, because servant will try to match the handlers in order.

Corresponds to the defaultWebAppSettings StaticSettings value.

valueserveDirectoryWebAppLookup :: ETagLookup -> FilePath -> ServerT Raw m

Same as serveDirectoryWebApp, but uses webAppSettingsWithLookup.

valueserveDirectoryFileServer :: FilePath -> ServerT Raw m

Same as serveDirectoryWebApp, but uses defaultFileServerSettings.

valueserveDirectoryEmbedded :: [(FilePath, ByteString)] -> ServerT Raw m

Uses embeddedSettings.

valueserveDirectoryWith :: StaticSettings -> ServerT Raw m

Alias for staticApp. Lets you serve a directory with arbitrary StaticSettings. Useful when you want particular settings not covered by the four other variants. This is the most flexible method.

Deprecated

1 declaration

valueserveDirectory :: FilePath -> ServerT Raw m

Deprecated. Use serveDirectoryFileServer instead

Same as serveDirectoryFileServer. It used to be the only file serving function in servant pre-0.10 and will be kept around for a few versions, but is deprecated.