aws-samples / smithy-server-generator-typescript-sample

Smithy Server Generator for TypeScript Example Service

Overview

This repository is divided into three projects:

• model contains the Smithy model for the service.
• typescript-client contains the generated TypeScript client generated from model.
• server contains the service, written in TypeScript, for model.

Building

Prerequisites

Before beginning:

• Install
  • JDK >= 8
  • NodeJS >= 14
  • AWS CDK CLI
• Enable corepack by running corepack enable
• Set up an AWS account if you do not have one
• Configure your workstation so the CDK can use your account

Getting started

1. After the first checkout, you will need to kick off the initial code generation and build by running:

   ./gradlew build && yarn install && yarn build

   After this initial build, yarn build in the root of the project will regenerate the client and server and recompile all of the code.
2. To deploy the service, switch to the server directory and run cdk deploy. When complete, the CDK will print out the endpoint URL for your newly deployed service.

   Note: this step will create resources in your AWS account that may incur charges.

3. To test your service, switch to the typescript-client directory and use yarn str-length to call the Length operation. For example, given an output from the CDK of https://somerandomstring.execute-api.us-west-2.amazonaws.com/prod/,

   yarn str-length https://somerandomstring.execute-api.us-west-2.amazonaws.com/prod/ foobar

   should print out 6.

Security

See CONTRIBUTING for more information.

License

This library is licensed under the MIT-0 License. See the LICENSE file.