Skip to content

Latest commit

 

History

History
69 lines (45 loc) · 1.78 KB

README.md

File metadata and controls

69 lines (45 loc) · 1.78 KB
Raw

angular2-swagger-apiclient-generator

Angular 2 API client generator from swagger json

Description

This package generates a angular2 typescript class from a swagger v2.0 specification file. The code is generated using mustache templates.

How to get it working

Installation

  1. npm install swagger2ng2

or

  1. get it from github git clone https://github.com/syron/angular2-swagger-client-generator
  2. cd angular2-swagger-client-generator
  3. npm install
  4. npm run build
  5. If you want to run globally run npm install -g

Usage

From commandline run:

swagger2ng2 -s [your/path/to/swagger.json] -c [className] -g [GenerateParameter]

or

swagger2ng2 -u [url/of/your/swagger.json] -c [className] -g [GenerateParameter]

If parameter -c is not provided, class name will be ApiClient Service.

Available values for parameter -g are I, M, C or F, as well as you can combine them.

Parameters

Options:

-s, --source Path to your swagger.json file

-u, --url Url of your swagger.json file

-o, --outputpath Path where to store generated files

-c, --className Class name for Api client

-g, --generate What to generate, F for full (default), I for interfaces, M for models, C for classes

-f, --fileName Example '-f index' will generate both index.ts and index.interface.ts.

-p, --modelPath If used, p provides a relative path to the place where models are stored.

Example usage:

This command will generate API client described in swagger.json file to ./out folder

swagger2ng2 -s .\tests\apis\swagger.json -o ./out

or from repository directory run:

node ./src/main -s .\tests\apis\swagger.json -o ./out

##Note: This project was inspired by:

swagger-js-codegen project