Add docs for serving static files (#2554)

* add docs for serving static files * fmt
zio · Dec 12, 2023 · 9a9aef2 · 9a9aef2
1 parent f9ffb0b
commit 9a9aef2
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/docs/examples/advanced/static-files.md b/docs/examples/advanced/static-files.md
@@ -0,0 +1,23 @@
+---
+id: static-files
+title: "Serving Static Files"
+sidebar_label: "Static Files"
+---
+
+```scala mdoc:silent
+import zio._
+import zio.http._
+
+object StaticFiles extends ZIOAppDefault {
+
+  /**
+   * Creates an HTTP app that only serves static files from resources via
+   * "/static". For paths other than the resources directory, see
+   * [[Middleware.serveDirectory]].
+   */
+  val app = Routes.empty.toHttpApp @@ Middleware.serveResources(Path.empty / "static")
+
+  override def run = Server.serve(app).provide(Server.default)
+}
+
+```
diff --git a/zio-http-example/src/main/scala/example/StaticFiles.scala b/zio-http-example/src/main/scala/example/StaticFiles.scala
@@ -0,0 +1,17 @@
+package example
+
+import zio._
+
+import zio.http._
+
+object StaticFiles extends ZIOAppDefault {
+
+  /**
+   * Creates an HTTP app that only serves static files from resources via
+   * "/static". For paths other than the resources directory, see
+   * [[Middleware.serveDirectory]].
+   */
+  val app = Routes.empty.toHttpApp @@ Middleware.serveResources(Path.empty / "static")
+
+  override def run = Server.serve(app).provide(Server.default)
+}