Merge pull request #16 from acacode/release/1.3.0

release/1.3.0

Author: js2me

.gitignore

@@ -1,2 +1,3 @@
 node_modules
+.vscode
 swagger-test-cli.ts

.travis.yml

@@ -22,8 +22,7 @@ jobs:
   include:
     - stage: generate&validate
       script:
-        - npm run generate
-        - npm run validate
+        - npm run test:all
 
 notifications:
   slack:

CHANGELOG.md

@@ -1,3 +1,17 @@
+# 1.3.0  
+Features:  
+  - Api module description from schema info  
+    ![api description](./assets/changelog_assets/api-module-description.jpg)  
+  - Generate API type declarations (CLI flag `--route-types`)  
+    ![route types](./assets/changelog_assets/route-types.jpg)  
+  - Ability to not generate clint API class (CLI flag `--no-client`)  
+
+Fixes:  
+  - Improve response body type definition  
+
+Internal:  
+  - refactored `generate` and `validate` test scripts  
+
 # 1.2.6  
 Fixes: create api without `-o` option (use default `./` output)  
 

README.md

@@ -32,8 +32,10 @@ Usage: swagger-typescript-api [options]
 Options:
   -v, --version          output the current version
   -p, --path <path>      path/url to swagger scheme
-  -o, --output <output>  output path of typescript api file (default: ".")
+  -o, --output <output>  output path of typescript api file (default: "./")
   -n, --name <name>      name of output typescript api file (default: "api.ts")
+  --route-types          generate type definitions for API routes (default: false)
+  --no-client            do not generate an API class
   -h, --help             output usage information
 ```
 
@@ -64,7 +66,7 @@ generateApi({
 
 ```
 
-## 🚀 How it looks
+## 🚀 How it looks  
 
 ![](https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/npx.gif)  
 
@@ -73,6 +75,12 @@ generateApi({
 ![](https://raw.githubusercontent.com/acacode/swagger-typescript-api/master/assets/typings1.gif)  
 
 
+## 🛠️ Contribution  
+
+You can manually check your changes at schemas in `tests` folder before create a PR.  
+To do that have scripts:  
+    - `npm run generate` - generate API modules from schemas in `tests` folder  
+    - `npm run validate` - validate generated API modules via TypeScript  
 
 ## 📝 License  
 Licensed under the [MIT License](https://github.com/acacode/swagger-typescript-api/blob/master/LICENSE).

assets/changelog_assets/api-module-description.jpg

@@ -16,15 +16,19 @@ program
   .description("Generate api via swagger scheme.\nSupports OA 3.0, 2.0, JSON, yaml.")
   .requiredOption('-p, --path <path>', 'path/url to swagger scheme')
   .option('-o, --output <output>', 'output path of typescript api file', './')
-  .option('-n, --name <name>', 'name of output typescript api file', 'api.ts');
+  .option('-n, --name <name>', 'name of output typescript api file', 'api.ts')
+  .option('--route-types', 'generate type definitions for API routes', false)
+  .option('--no-client', 'do not generate an API class', false);
 
 program.parse(process.argv);
 
-const { path, output, name } = program;
+const { path, output, name, routeTypes, client } = program;
 
 generateApi({
   name,
   url: path,
+  generateRouteTypes: routeTypes,
+  generateClient: client,
   input: resolve(process.cwd(), path),
   output: resolve(process.cwd(), output || '.')
 })