AWS CDK support for Tapir endpoints #2587
Conversation
doc/server/aws.md
Outdated
| @@ -66,6 +66,19 @@ output the url of the created API Gateway which you can call followed by `/api/h | |||
|
|
|||
| To destroy all the created resources run `terraform destroy`. | |||
|
|
|||
| ### CDK | |||
There was a problem hiding this comment.
We have two distinct deployment options for tapir-serverless on AWS: SAM and CDK, so I think we'd need some guide at the top as to what are the responsibilities of the various modules, and in which combinations they should be used, and which dependencies to add. Right now I think it would be challenging to a new user to understand how a serverless tapir endpoint can be deployed.
There was a problem hiding this comment.
As a side note, Examples > SAM and Examples > SAM Example are confusing ;) (not directly connected to CDK, but might be good to cleanup up as well)
There was a problem hiding this comment.
I changed documentation, feel free to check whether it makes sense :)
| case class AwsRequestContext(domainName: Option[String], http: AwsHttp) | ||
| case class AwsHttp(method: String, path: String, protocol: String, sourceIp: String, userAgent: String) | ||
|
|
||
| case class AwsResponse(cookies: List[String], isBase64Encoded: Boolean, statusCode: Int, headers: Map[String, String], body: String) | ||
| case class AwsResponse(isBase64Encoded: Boolean, statusCode: Int, headers: Map[String, String], body: String) |
There was a problem hiding this comment.
maybe this has been explained before, but in the 2.0 model, there are cookies - why are we removing them here?
some comment in code would be necessary if we divert from the aws model
There was a problem hiding this comment.
@ayeo do you remember why? 😉
There was a problem hiding this comment.
afaik headers are responsible for curring cookies. And there has never been a such a concept in AWS Response - but not sure today, needs to be checked :)
There was a problem hiding this comment.
https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-create-api-as-simple-proxy on the very bottom is the model shape presented
| } | ||
|
|
||
| /** | ||
| * I could NOT managed to enforce CDK to use payload version 2.0 At time of this writing no valuable |
There was a problem hiding this comment.
[minor] grammar + let's just write, that we need the v1 version to implement CDK, as that's what the framework supports
There was a problem hiding this comment.
I changed this one as well
| package object lambda { | ||
|
|
||
| trait Mapper[A] { |
There was a problem hiding this comment.
instead of mappers and implicits, let's just add this as a method to AwsRequestV1
There was a problem hiding this comment.
wdyt about 3b88efa ?
As I understand the situation, at some point we would like to drop the AwsRequestV1 and use just the other one?
| .use(content => Sync[F].delay(content.getLines().mkString(System.lineSeparator()))) | ||
|
|
||
| private def copy(from: String, to: String): F[Unit] = { | ||
| val bytes = Source.fromInputStream(getClass.getResourceAsStream(sourceDir + "/" + from)).getLines().mkString("\n") |
There was a problem hiding this comment.
this should also be surrounded by Sync[F].blocking
| @@ -0,0 +1,75 @@ | |||
| package sttp.tapir.serverless.aws.cdk.core | |||
There was a problem hiding this comment.
[naming] I think in tapir mostly internal stuff is in an internal package
|
Great docs, thanks! :) |
No description provided.