Added sttp docs and examples

hnaderi · Sep 26, 2022 · 687a72b · 687a72b
1 parent 44f40fa
commit 687a72b
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -51,6 +51,7 @@ The following integrations are currently available:
 libraryDependencies ++= Seq(
   "dev.hnaderi" %% "scala-k8s-http4s" % "@VERSION@", // JVM, JS, Native ; http4s and fs2 integration
   "dev.hnaderi" %% "scala-k8s-zio" % "@VERSION@", // JVM ; ZIO native integration using zio-http and zio-json 
+  "dev.hnaderi" %% "scala-k8s-sttp" % "@VERSION@", // JVM, JS, Native ; sttp integration using jawn parser
   "dev.hnaderi" %% "scala-k8s-circe" % "@VERSION@", // JVM, JS ; circe integration
   "dev.hnaderi" %% "scala-k8s-json4s" % "@VERSION@", // JVM, JS, Native; json4s integration
   "dev.hnaderi" %% "scala-k8s-spray-json" % "@VERSION@", // JVM ; spray-json integration
@@ -68,6 +69,6 @@ visit [project site](https://projects.hnaderi.dev/scala-k8s) to see more tutoria
 see [this project](https://github.com/hnaderi/sbt-k8s)
 
 ## Future plans
-- more integrations (ZIO, sttp, akka-http)!
+- more integrations (akka-http, ...)!
 - more requests and options
 - direct TLS support
diff --git a/build.sbt b/build.sbt
@@ -274,10 +274,11 @@ lazy val docs = project
       "Jawn" -> url("https://github.com/typelevel/jawn")
     ),
     libraryDependencies ++= Seq(
-      "org.http4s" %%% "http4s-circe" % "0.23.16"
+      "org.http4s" %%% "http4s-circe" % "0.23.16",
+      "com.softwaremill.sttp.client3" %%% "circe" % "3.8.0"
     )
   )
-  .dependsOn(http4s.jvm, circe.jvm, manifests.jvm)
+  .dependsOn(http4s.jvm, sttp.jvm, circe.jvm, manifests.jvm)
 
 lazy val unidocs = project
   .in(file("unidocs"))

diff --git a/docs/index.md b/docs/index.md
@@ -22,6 +22,7 @@ The following integrations are currently available:
 libraryDependencies ++= Seq(
   "dev.hnaderi" %% "scala-k8s-http4s" % "@VERSION@", // JVM, JS, Native ; http4s and fs2 integration
   "dev.hnaderi" %% "scala-k8s-zio" % "@VERSION@", // JVM ; ZIO native integration using zio-http and zio-json 
+  "dev.hnaderi" %% "scala-k8s-sttp" % "@VERSION@", // JVM, JS, Native ; sttp integration using jawn parser
   "dev.hnaderi" %% "scala-k8s-circe" % "@VERSION@", // JVM, JS ; circe integration
   "dev.hnaderi" %% "scala-k8s-json4s" % "@VERSION@", // JVM, JS, Native; json4s integration
   "dev.hnaderi" %% "scala-k8s-spray-json" % "@VERSION@", // JVM ; spray-json integration
@@ -213,6 +214,26 @@ val client = ZIOKubernetesClient.make("http://localhost:8001")
 val nodes = ZIOKubernetesClient.send(APIs.nodes.list())
 ```
 
+### Sttp based client
+```scala mdoc:compile-only
+import dev.hnaderi.k8s.circe._
+import dev.hnaderi.k8s.client.APIs
+import dev.hnaderi.k8s.client.SttpKubernetesClient
+import io.circe.Json
+import sttp.client3._
+import sttp.client3.circe._
+
+val simpleBackend = HttpURLConnectionBackend()
+
+val client = new SttpKubernetesClient[Identity, Json](
+  "http://localhost:8001",
+  simpleBackend
+)
+
+val nodes = APIs.nodes.list().send(client)
+nodes.body.items.flatMap(_.metadata).flatMap(_.name).foreach(println)
+```
+
 ### Working with requests
 Requests are plain data, so you can manipulate or pass them like any normal data