5

我有一个简单的 hello world Servant 应用程序。我需要向它添加一些静态或动态的 html 页面。我怎样才能做到这一点？在文档中没有提到它。注意我不想在 Haskell 代码中创建 html 布局，我希望 Haskell 显示已经创建的 html 页面。

更新：

我怎样才能结合这个：

type MyApi = "/" :> Raw

server :: Server MyApi
server = serveDirectory "static/" -- index.html, about.html

有了我已经拥有的：

  type API = 
    "api" :> "items" :> Get '[JSON] [MyData] :<|>
    "api" :> "items" :> Capture "id" Int :> Get '[JSON] MyData


  app :: Application
  app = serve api server

  api :: Proxy API
  api = Proxy

  server :: Server API
  server = getItems :<|> getItem

  startApp :: IO ()
  startApp =  run 1234 app

更新2：

在职的：

type API = 
    "api" :> "items" :> Get '[JSON] [MyData] :<|>
    "api" :> "items" :> Capture "id" Int :> Get '[JSON] MyData :<|>
    Raw

不工作，根本没有反应：

type API = 
    "api" :> "items" :> Get '[JSON] [MyData] :<|>
    "api" :> "items" :> Capture "id" Int :> Get '[JSON] MyData :<|>
    "/" :> Raw

-- or

type API = 
    "api" :> "items" :> Get '[JSON] [MyData] :<|>
    "api" :> "items" :> Capture "id" Int :> Get '[JSON] MyData :<|>
    "" :> Raw

我想知道为什么？

4

1 回答 1

7

如何结合 REST API 和静态 html 页面？

您可以在根路径提供包含您的静态网站的目录serveDirectory。它必须是您的 Servant API 中的最后一个案例，否则其他案例将永远无法匹配。

type API = 
    "api" :> "items" :> Get '[JSON] [MyData] :<|>
    "api" :> "items" :> Capture "id" Int :> Get '[JSON] MyData :<|>
    Raw

api :: Proxy API 
api = Proxy

server :: Server API 
server = getItems
    :<|> getItem 
    :<|> serveDirectory "static/"

此外，如果任何静态页面名称与您的 API 崩溃，它将被隐藏。

为什么不是"/" :> Raw？

看起来我的浏览器缓存了一些静态页面。清理缓存后"/" :> Raw没有响应。/index.html

api中的字符串文字将首先被编码为合法的uri部分，因此您的文件将被映射到"/"等等。"%2F"/%2F/index.html

你知道我该如何处理根案吗？

要在根路径提供响应，您可以定义一个Get不带前缀的端点：

type API = Get '[HTML] RawHtml

它可以位于 API 中除最后一行之外的任何位置。

要将本地文件作为 html 响应提供，您必须将该文件与其他字节字符串区分开来，也许将其包装在一个新类型中：

newtype RawHtml = RawHtml { unRaw :: BS.ByteString }

-- tell Servant how to render the newtype to html page, in this case simply unwrap it
instance MimeRender HTML RawHtml where
    mimeRender _ =  unRaw

在你的控制器中：

-- ...
:<|> fmap RawHtml (liftIO $ BS.readFile "your/file/path.html")

或者，如果页面已经有另一个地址，您可以将用户重定向到那里：

-- ...
:<|> throwError err301 { errHeaders = [("Location", "index.html")] }

它已经返回 index.html。嗯，为什么是 index.html？

serveDirectorystaticApp使用设置调用 wai 应用程序defaultFileServerSettings。在该设置中，用户将被重定向到index.htm或者index.html如果出现问题：

defaultFileServerSettings root = StaticSettings
    { ssLookupFile = fileSystemLookup (fmap Just . hashFile) root
    , ssMkRedirect = defaultMkRedirect
    , ssGetMimeType = return . defaultMimeLookup . fromPiece . fileName
    , ssMaxAge = NoMaxAge
    , ssListing = Just defaultListing
    , ssIndices = map unsafeToPiece ["index.html", "index.htm"]
    , ssRedirectToIndex = False
    , ssUseHash = False
    , ssAddTrailingSlash = False
    , ss404Handler = Nothing
    }
于 2016-04-02T12:42:55.520 回答