https://github.com/innfactory/smithy4play
smithy4s Routing for Play Framework.
https://github.com/innfactory/smithy4play
play2 play3 scala scala3 smithy smithy4s
Last synced: about 1 year ago
JSON representation
smithy4s Routing for Play Framework.
- Host: GitHub
- URL: https://github.com/innfactory/smithy4play
- Owner: innFactory
- License: apache-2.0
- Created: 2022-05-09T08:47:06.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-28T00:25:51.000Z (over 1 year ago)
- Last Synced: 2024-11-28T01:26:04.107Z (over 1 year ago)
- Topics: play2, play3, scala, scala3, smithy, smithy4s
- Language: Scala
- Homepage: https://innfactory.de
- Size: 771 KB
- Stars: 14
- Watchers: 7
- Forks: 1
- Open Issues: 19
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
[](https://github.com/innFactory/smithy4play/actions/workflows/build.yml)
# Smithy4Play
smithy4play is a routing gernator for the play2 framework based on [smithy4s](https://github.com/disneystreaming/smithy4s). Just write your smithy API definition and the plugin will generate everything you need for play2 framework usage.
---
## QuickStart
### Add smithy4play to your project
plugins.sbt
```scala
addSbtPlugin("com.typesafe.play" % "sbt-plugin" % "2.*.*")
addSbtPlugin("com.codecommit" % "sbt-github-packages" % "0.*.*")
addSbtPlugin(
"com.disneystreaming.smithy4s" % "smithy4s-sbt-codegen" % "0.*.*"
)
```
build.sbt
```scala
.enablePlugins(Smithy4sCodegenPlugin, PlayScala)
.settings(
githubSettings,
Compile / smithy4sInputDir := (ThisBuild / baseDirectory).value / "smithy-in",
Compile / smithy4sOutputDir := (ThisBuild / baseDirectory).value / "smithy-out",
libraryDependencies += "de.innfactory" %% "smithy4play" % "latestVersion")
```
### Usage
- define your controllers in smithy files
- use smithy4s codegen (sbt compile)
**Server**
- create controller scala class
- extend your Controller with the generated Scala Type and smithy4play Type ContextRoute
```scala
@Singleton
class PreviewController @Inject(
)(implicit
cc: ControllerComponents,
ec: ExecutionContext
) extends PreviewControllerService[ContextRoute] {
override def preview(bye: PreviewBody): ContextRoute[PreviewResponse] =
Kleisli { rc =>
EitherT.rightT[Future, ContextRouteError](PreviewResponse(Some("Hello")))
}
}
```
**Client**
- import the EnhancedGenericAPIClient
```scala
import de.innfactory.smithy4play.client.GenericAPIClient.EnhancedGenericAPIClient
val previewControllerClient = PreviewControllerServiceGen.withClient(FakeRequestClient)
previewControllerClient.preview()
```
For a further examples take a look at the smithy4playTest project.
## Routing
You can choose between autorouting or selfbinding.
### Autorouting
- Annotate your controller with ```@AutoRouting```
- add ```scalacOptions += "-Ymacro-annotations"``` to your build.sbt settings to enable macro annotations
- bind the smithy4play AutoRouter in the play routes file
```scala
-> / de.innfactory.smithy4play.AutoRouter
```
- add package name to configuration
```scala
smithy4play.autoRoutePackage = "your.package.name"
```
### Selfbinding
- Create a ApiRouter class and inject your controller
```scala
@Singleton
class ApiRouter @Inject()(
homeController: HomeController,
pizzaController: PizzaController
)(implicit
cc: ControllerComponents,
ec: ExecutionContext
) extends BaseRouter {
override val controllers: Seq[Routes] =
Seq(homeController, pizzaController)
}
```
- bind the ApiRouter in the play routes file
```scala
-> / api.ApiRouter
```
## Middlewares
If you want Middlewares that run before the endpoint logic follow these steps:
- Implement Middlewares
```scala
@Singleton
class ExampleMiddleware @Inject() (implicit
executionContext: ExecutionContext
) extends MiddlewareBase {
override protected def skipMiddleware(r: RoutingContext): Boolean = false
override def logic(
r: RoutingContext,
next: RoutingContext => RouteResult[EndpointResult]
): RouteResult[EndpointResult] =
next(r)
}
```
- Implement a MiddlewareRegistry and register your middlewares
```scala
class MiddlewareRegistry @Inject() (
disableAbleMiddleware: DisableAbleMiddleware,
testMiddlewareImpl: TestMiddlewareImpl,
validateAuthMiddleware: ValidateAuthMiddleware
) extends MiddlewareRegistryBase {
override val middlewares: Seq[MiddlewareBase] = Seq(ExampleMiddleware)
}
```
## Credits:
[innFactory ❤️ Open Source](https://innfactory.de)