From aa84b692cc9a1a5eb5d386945bde6bdf1c29b2c7 Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Thu, 28 Oct 2021 12:52:06 +0530 Subject: [PATCH 1/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c1b3fe7..53a8263 100644 --- a/README.md +++ b/README.md @@ -78,7 +78,7 @@ You can now continue with [generating code](#generate-code). ### Console -> Tip: If you use Docker, run `make bash` before running any of these commands. +> Tip: If you use Docker, run `make cli` before running any of these commands. Run `./yii gii/api` to generate your API code. The `--openApiPath` parameter specifies the path to your OpenAPI spec file. The following example will generate API code for the [OpenAPI petstore example](https://github.com/OAI/OpenAPI-Specification/blob/3.0.2/examples/v3.0/petstore-expanded.yaml). From 0985f9f937758409f6f97e6eafc8b09faebde785 Mon Sep 17 00:00:00 2001 From: Sohel Ahmed Mesaniya Date: Fri, 29 Oct 2021 15:04:25 +0530 Subject: [PATCH 2/2] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 53a8263..29af92d 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,8 @@ You can now continue with [generating code](#generate-code). ## Generate Code +Note: If OpenAPI spec file is present locally on the file system, then for UNIX bases OS, `openApiPath` must start with `/` and should provide aboslute path instead of relative path from the current directory. Example: `/home/user/documents/MyProjectOpenAPISpec.yml` + ### Console > Tip: If you use Docker, run `make cli` before running any of these commands.