Skip to content

Commit 819f22f

Browse files
authored
docs(readme): update (#42)
1 parent c8285ca commit 819f22f

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,14 @@ yarn add -D @himenon/openapi-typescript-code-generator
1818

1919
## DEMO
2020

21-
- [DEMO](./example/README.md)
21+
- [Short DEMO](https://github.com/Himenon/openapi-typescript-code-generator-demo-project)
2222
- [DEMO: github/rest-api-client code generate](https://github.com/Himenon/github-rest-api-client/tree/master/source)
2323
- https://github.com/github/rest-api-description
2424

2525
## Usage
2626

27+
The example shown here can be cloned from the [DEMO repository](https://github.com/Himenon/openapi-typescript-code-generator-demo-project) to see how it works.
28+
2729
### Generate typedef-only code
2830

2931
```ts
@@ -89,7 +91,7 @@ const main = () => {
8991
const apiClientCode = codeGenerator.generateCode([
9092
{
9193
generator: () => {
92-
return [`import { Schemas } from "./types";`];
94+
return [`import { Schemas, Responses } from "./types";`];
9395
},
9496
},
9597
codeGenerator.getAdditionalTypeDefinitionCustomCodeGenerator(),

docs/ja/README-ja.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ OpenAPI から抽出したパラメーターは自由に使うことができる
1010

1111
## DEMO
1212

13-
- [DEMO](../example/README.md)
13+
- [Short DEMO](https://github.com/Himenon/openapi-typescript-code-generator-demo-project)
1414
- [DEMO: github/rest-api-client code generate](https://github.com/Himenon/github-rest-api-client/tree/master/source)
1515
- https://github.com/github/rest-api-description
1616

@@ -22,6 +22,8 @@ yarn add -D @himenon/openapi-typescript-code-generator
2222

2323
## 使い方
2424

25+
ここで記されている例は[DEMO用のリポジトリ](https://github.com/Himenon/openapi-typescript-code-generator-demo-project)をクローンして動作確認することができます。
26+
2527
### 型定義のみのコードを生成する
2628

2729
```ts
@@ -87,7 +89,7 @@ const main = () => {
8789
const apiClientCode = codeGenerator.generateCode([
8890
{
8991
generator: () => {
90-
return [`import { Schemas } from "./types";`];
92+
return [`import { Schemas, Responses } from "./types";`];
9193
},
9294
},
9395
codeGenerator.getAdditionalTypeDefinitionCustomCodeGenerator(),

0 commit comments

Comments
 (0)