[FEATURE] [open-api-gateway] Smithy Support #145
Comments
cogwirrel
added a commit
that referenced
this issue
Sep 12, 2022
…efinition language Adds three new projen project types (ts/python/java) where Smithy can be used instead of OpenAPI as the interface definition language. Smithy is projected into OpenAPI as a pre-step, which allows us to reuse the same generated clients, handler wrappers and infrastructure. fix #145
cogwirrel
added a commit
that referenced
this issue
Sep 12, 2022
…efinition language Adds three new projen project types (ts/python/java) where Smithy can be used instead of OpenAPI as the interface definition language. Smithy is projected into OpenAPI as a pre-step, which allows us to reuse the same generated clients, handler wrappers and infrastructure. fix #145
cogwirrel
added a commit
that referenced
this issue
Sep 13, 2022
…efinition language Adds three new projen project types (ts/python/java) where Smithy can be used instead of OpenAPI as the interface definition language. Smithy is projected into OpenAPI as a pre-step, which allows us to reuse the same generated clients, handler wrappers and infrastructure. fix #145
cogwirrel
added a commit
that referenced
this issue
Sep 13, 2022
…efinition language Adds three new projen project types (ts/python/java) where Smithy can be used instead of OpenAPI as the interface definition language. Smithy is projected into OpenAPI as a pre-step, which allows us to reuse the same generated clients, handler wrappers and infrastructure. fix #145
cogwirrel
added a commit
that referenced
this issue
Sep 13, 2022
…efinition language Adds three new projen project types (ts/python/java) where Smithy can be used instead of OpenAPI as the interface definition language. Smithy is projected into OpenAPI as a pre-step, which allows us to reuse the same generated clients, handler wrappers and infrastructure. fix #145
cogwirrel
added a commit
that referenced
this issue
Sep 14, 2022
…efinition language Adds three new projen project types (ts/python/java) where Smithy can be used instead of OpenAPI as the interface definition language. Smithy is projected into OpenAPI as a pre-step, which allows us to reuse the same generated clients, handler wrappers and infrastructure. fix #145
cogwirrel
added a commit
that referenced
this issue
Sep 14, 2022
…efinition language Adds three new projen project types (ts/python/java) where Smithy can be used instead of OpenAPI as the interface definition language. Smithy is projected into OpenAPI as a pre-step, which allows us to reuse the same generated clients, handler wrappers and infrastructure. fix #145
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Describe the feature
As an alternative to OpenAPI, it would be great if APIs could be defined with Smithy, a protocol-agnostic IDL.
Use Case
Defining APIs in an alternative, non-yaml format, less verbose than OpenAPI without the need to understand
$refandallOfetc.Proposed Solution
New projen constructs
SmithyApiGateway<Language>Projectcould be exposed by theopen-api-gatewaypackage which will generate the sample hello world api in Smithy IDL.Smithy IDL can be converted to OpenAPI, so we would add this as a pre-step such that the generated clients, construct etc can be reused.
Smithy IDL allows for authorizers to be specified, so we would need to figure out a neat way to marry up those specified in the
OpenApiGatewayLambdaApiCDK construct with those specified in the spec.Other Information
Generated lambda handler wrappers would all still be generated and in theory would work with no change, however we might also wish to provide the option to use the Smithy Server SDK for Typescript as an alternative for writing type-safe lambda handlers in typescript.
Acknowledgements
PDK version used
0.8.x
What languages will this feature affect?
Typescript, Java, Python
Environment details (OS name and version, etc.)
All!
The text was updated successfully, but these errors were encountered: