https://github.com/amzn/smoke-framework-examples

Sample applications showing the usage of the SmokeFramework and related libraries.
https://github.com/amzn/smoke-framework-examples

Last synced: about 1 month ago
JSON representation

Sample applications showing the usage of the SmokeFramework and related libraries.

• Host: GitHub
• URL: https://github.com/amzn/smoke-framework-examples
• Owner: amzn
• License: apache-2.0
• Created: 2019-02-19T02:36:59.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-04-05T12:04:40.000Z (over 1 year ago)
• Last Synced: 2024-04-10T10:32:55.992Z (5 months ago)
• Language: Swift
• Size: 229 KB
• Stars: 22
• Watchers: 11
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


























# SmokeFrameworkExamples

Sample services showing the usage of the [SmokeFramework](https://github.com/amzn/smoke-framework) and related libraries.

## EmptyExampleService

An example of a service as it is generated using [SmokeFrameworkApplicationGenerate](https://github.com/amzn/smoke-framework-application-generate)

with the command-

```bash

swift run -c release SmokeFrameworkApplicationGenerate \

  --base-file-path ${workspaceRoot}/smoke-framework-examples/EmptyExampleService

```

## PersistenceExampleService

An example of a service using [SmokeDynamoDb](https://github.com/amzn/smoke-dynamodb) to store and retrieve data.

Initially generated using [SmokeFrameworkApplicationGenerate](https://github.com/amzn/smoke-framework-application-generate)

with the command-

```bash

swift run -c release SmokeFrameworkApplicationGenerate \

  --base-file-path ${workspaceRoot}/smoke-framework-examples/PersistenceExampleService \

```

## NoExistentialTypesExampleService

A variant of `PersistenceExampleService` that uses a generic context. This will mean that at runtime calls from operation

handlers to the DynamoDB table in the context will directly use the concrete `AWSDynamoDBCompositePrimaryKeyTable`

type rather than first using an existential type of the `DynamoDBCompositePrimaryKeyTable` protocol (an additional layer of redirection).

## OtherServiceModel

A Swift package wrapper around an Open API 3.0 model. Allows this model to be used by codegen SwiftPM plugins in conjunction with a consuming package.

## OtherServiceSwiftClient

An example of a Swift Client created for an API Gateway-hosted API. Uses the Open API 3.0 model specified in `OtherServiceModel`.

## ClientConsumingSmokeFrameworkService

An example of a smoke-framework-based service that uses the `OtherServiceSwiftClient` in one of its operations.

 

## License

This library is licensed under the Apache 2.0 License.