This is the reference documentation for an Alpakka connector. This section should contain a general overview of the connector and mention the libraries and APIs that the connector is using. Also it should link to external resources that might help to learn about the technology the connector is using.
@@dependency [sbt,Maven,Gradle] { group=com.lightbend.akka artifact=akka-stream-alpakka-reference_$scalaBinaryVersion$ version=$version$ }
Give a brief description of the usage of this connector. If you want to mention a class name, make sure to link to the API docs: @scaladocReferenceReadMessage.
If any of the API classes are different between Scala and Java, link to both API docs: @scala[@scaladocReference] @java[@scaladocReference].
Show an example code snippet of how a source of this connector can be created.
Scala : @@snip snip { #source }
Java : @@snip snip { #source }
Wrap language specific text with language specific directives,
like @scala[@scala for Scala specific text]@java[@java for Java specific text].
Show an example code snippet of how a flow of this connector can be created.
Scala : @@snip snip { #flow }
Java : @@snip snip { #flow }
The code in this guide is part of runnable tests of this project. You are welcome to edit the code and run it in sbt.
Scala
: sbt > reference/testOnly *.ReferenceSpec
Java
: sbt > reference/testOnly *.ReferenceTest