Skip to content

Commit 7f55ab4

Browse files
committed
Tapir & sttp docs
1 parent 4a36eec commit 7f55ab4

File tree

3 files changed

+32
-0
lines changed

3 files changed

+32
-0
lines changed

doc/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@ In addition to this documentation, ScalaDocs can be browsed at [https://javadoc.
9191
integrations/mdc-logback
9292
integrations/cron4s
9393
integrations/otel-context
94+
integrations/tapir
95+
integrations/sttp-client
9496
9597
.. toctree::
9698
:maxdepth: 2

doc/integrations/sttp-client.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# HTTP client using sttp
2+
3+
[sttp-client](https://sttp.softwaremill.com) is a Scala HTTP client integrating with a number of Scala stacks,
4+
including direct-style backends.
5+
6+
The integration is included in the sttp-client library and includes:
7+
* synchronous backends, which are designed to work with direct-style Scala
8+
* streaming request & response bodies, converted to/from `Flow`s via `InputStream`s
9+
* interacting with WebSockets, either using the `WebSocket` interface directly, or using `Flow`s of web socket frames
10+
* receiving SSE streams as `Flow[ServerSentEvent]`
11+
12+
For more details refer to the sttp-client documentation, specifically:
13+
* [synchronous backends documentation](https://sttp.softwaremill.com/en/latest/backends/synchronous.html)
14+
* [usage examples](https://sttp.softwaremill.com/en/latest/examples.html), tagged with the `Direct` label

doc/integrations/tapir.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# HTTP server using Tapir
2+
3+
[Tapir](https://tapir.softwaremill.com) is a library for rapidly developing HTTP APIs. It integrates with a number of
4+
Scala stacks, including direct-style server interpreters.
5+
6+
The integration is included in the Tapir library and includes:
7+
* exposing regular HTTP endpoints (consuming/producing JSON etc.)
8+
* streaming request & response bodies, converted to/from `Flow`s via `InputStream`s
9+
* web sockets represented as a transformation between incoming & outgoing `Flow`s of web socket frames
10+
* SSE response bodies
11+
12+
For more details refer to the Tapir documentation, specifically:
13+
* the [netty-server-sync interpreter documentation](https://tapir.softwaremill.com/en/latest/server/netty.html)
14+
* [usage examples](https://tapir.softwaremill.com/en/latest/examples.html), tagged with the `Direct` label
15+
* [tutorials](https://tapir.softwaremill.com/en/latest/tutorials/01_hello_world.html), which mostly use the
16+
direct-style approach

0 commit comments

Comments
 (0)