Skip to content

Commit 9c5b0b1

Browse files
committed
docs: explain the output
- `README` explains about the output in the section "Getting started".
1 parent 97b33d2 commit 9c5b0b1

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

README.ja.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ const api = RestApiWithSpec.createRestApi(this, 'example-api', {
4646
});
4747
```
4848

49+
CDKスタックを合成すると、OpenAPI定義を含む`openapi.json`ファイルが作成されます。
50+
4951
より詳しくは[使用例](#使用例)[APIドキュメンテーション](#apiドキュメンテーション)をご参照ください。
5052
実際に動くサンプルも[`example`](./example/README.ja.md)フォルダにあります。
5153

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,8 @@ const api = RestApiWithSpec.createRestApi(this, 'example-api', {
4646
});
4747
```
4848

49+
After synthesizing the CDK stack, you will find a file `openapi.json` containing the OpenAPI definition created.
50+
4951
Please refer to the [use cases](#use-cases) and the [API documentation](#api-documentation) for more details.
5052
You can also find a working example in the [`example`](./example) folder.
5153

0 commit comments

Comments
 (0)