Skip to content

Commit 3ba5e78

Browse files
author
luigi
committed
read me
1 parent cfc0beb commit 3ba5e78

File tree

1 file changed

+1
-13
lines changed
  • codegen/smithy-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/service

1 file changed

+1
-13
lines changed

codegen/smithy-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/service/README.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Overview
44

55
This project extends **Smithy Kotlin** to generate **service-side code** from Smithy models, targeting the **Ktor** framework for server implementation.
6-
It produces **complete service stubs**including routing, serialization/deserialization, authentication, and validationso developers can focus entirely on implementing business logic.
6+
It produces **complete service stubs**, including routing, serialization/deserialization, authentication, and validation, so developers can focus entirely on implementing business logic.
77

88
While Ktor is the default backend, the architecture is framework-agnostic, allowing future support for other server frameworks.
99

@@ -67,14 +67,11 @@ First, in **this repository**, build and publish the code generator locally:
6767
./gradlew publishToMavenLocal
6868
```
6969

70-
---
71-
7270
### Step 2: Create a New Kotlin Project
7371
Now, create a **new Kotlin project** where you will use the Smithy Kotlin service code generator.
7472

7573
From this point forward, **all steps apply to the new Kotlin project** you just created.
7674

77-
---
7875

7976
### Step 3: Configure `build.gradle.kts` in the New Project
8077

@@ -100,7 +97,6 @@ dependencies {
10097
}
10198
```
10299

103-
---
104100

105101
### Step 4: Create `smithy-build.json` in the New Project
106102
This is an example of smithy-build.json.
@@ -133,8 +129,6 @@ This is an example of smithy-build.json.
133129
}
134130
```
135131

136-
---
137-
138132
### Step 5: Define Your Smithy Model in the New Project
139133

140134
Create a `model` directory and add your `.smithy` files.
@@ -188,8 +182,6 @@ structure CustomError {
188182
}
189183
```
190184

191-
---
192-
193185
### Step 6: Generate the Service in the New Project
194186

195187
Run:
@@ -202,8 +194,6 @@ If you want to clean previously generated code:
202194
gradle clean
203195
```
204196

205-
---
206-
207197
### Step 7: Run the Generated Service
208198

209199
The generated service will be in the directory specified in `smithy-build.json` (`outputDirectory`).
@@ -213,8 +203,6 @@ gradle run
213203
```
214204
By default, it listens on port **8080**.
215205

216-
---
217-
218206
### Step 8: Adjust Service Configuration
219207

220208
You can override runtime settings (such as port or HTTP engine) using command-line arguments:

0 commit comments

Comments
 (0)