From 819f22fb747b5a0d3316fa73559c6961b13dc24f Mon Sep 17 00:00:00 2001 From: "K.Himeno" Date: Fri, 9 Apr 2021 00:14:28 +0900 Subject: [PATCH] docs(readme): update (#42) --- README.md | 6 ++++-- docs/ja/README-ja.md | 6 ++++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 74e4cafb..1315734e 100644 --- a/README.md +++ b/README.md @@ -18,12 +18,14 @@ yarn add -D @himenon/openapi-typescript-code-generator ## DEMO -- [DEMO](./example/README.md) +- [Short DEMO](/~https://github.com/Himenon/openapi-typescript-code-generator-demo-project) - [DEMO: github/rest-api-client code generate](/~https://github.com/Himenon/github-rest-api-client/tree/master/source) - /~https://github.com/github/rest-api-description ## Usage +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. + ### Generate typedef-only code ```ts @@ -89,7 +91,7 @@ const main = () => { const apiClientCode = codeGenerator.generateCode([ { generator: () => { - return [`import { Schemas } from "./types";`]; + return [`import { Schemas, Responses } from "./types";`]; }, }, codeGenerator.getAdditionalTypeDefinitionCustomCodeGenerator(), diff --git a/docs/ja/README-ja.md b/docs/ja/README-ja.md index 0e4a3f8d..ee0e919c 100644 --- a/docs/ja/README-ja.md +++ b/docs/ja/README-ja.md @@ -10,7 +10,7 @@ OpenAPI から抽出したパラメーターは自由に使うことができる ## DEMO -- [DEMO](../example/README.md) +- [Short DEMO](/~https://github.com/Himenon/openapi-typescript-code-generator-demo-project) - [DEMO: github/rest-api-client code generate](/~https://github.com/Himenon/github-rest-api-client/tree/master/source) - /~https://github.com/github/rest-api-description @@ -22,6 +22,8 @@ yarn add -D @himenon/openapi-typescript-code-generator ## 使い方 +ここで記されている例は[DEMO用のリポジトリ](/~https://github.com/Himenon/openapi-typescript-code-generator-demo-project)をクローンして動作確認することができます。 + ### 型定義のみのコードを生成する ```ts @@ -87,7 +89,7 @@ const main = () => { const apiClientCode = codeGenerator.generateCode([ { generator: () => { - return [`import { Schemas } from "./types";`]; + return [`import { Schemas, Responses } from "./types";`]; }, }, codeGenerator.getAdditionalTypeDefinitionCustomCodeGenerator(),