https://github.com/renepardon/swagger-jsonapi-codegen

A code generator based on swagger-codegen
https://github.com/renepardon/swagger-jsonapi-codegen

Last synced: 12 days ago
JSON representation

A code generator based on swagger-codegen

• Host: GitHub
• URL: https://github.com/renepardon/swagger-jsonapi-codegen
• Owner: renepardon
• License: gpl-3.0
• Created: 2018-02-14T11:46:49.000Z (almost 7 years ago)
• Default Branch: develop
• Last Pushed: 2018-05-30T06:58:58.000Z (over 6 years ago)
• Last Synced: 2024-04-24T00:44:14.331Z (7 months ago)
• Language: JavaScript
• Size: 151 KB
• Stars: 0
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![](https://img.shields.io/npm/v/swagger-jsonapi-codegen.svg) ![](https://img.shields.io/npm/dt/swagger-jsonapi-codegen.svg) [![Open Source Love](https://badges.frapsoft.com/os/v3/open-source.svg?v=102)](https://github.com/renepardon/swagger-jsonapi-codegen)

[![NPM](https://nodei.co/npm/swagger-jsonapi-codegen.png?downloads=true&downloadRank=true)](https://www.npmjs.com/package/swagger-jsonapi-codegen/)

---

# Swagger JSONAPI codegen

Generates valid Angular 4/5 (Typescript) API client file from Swagger documentation with Observables instead of Promises. The lib folder from this package is based on the *swagger-js-codegen*.

Where **-i** points to a valid swagger.json documentation and **-o** to a directory to save the client into. For all available options have a look at the **build-typescript.js** file.

## CLI Options

```

  Usage: build-typescript [options]

  Options:

    -i, --input [path]        The file to use

    -o, --output_path [path]  The output for the api ts to be placed

    -n, --output_name [name]  Defaults to the api_.ts

    -u, --url_host [url]      The host to the api, overrides the host in the swagger. EG: -u https://www.yourdomain.com

    -h, --help                output usage information

```

## Examples 

Simple use case package.json script:

    "swagger-codegen": "node ./node_modules/ts-node/dist/bin.js ./node_modules/swagger-jsonapi-codegen/build-typescript.js -i ./documentation/build/swagger.json -o ./src/app/api/"

    

Override the base host from your swagger file:

    "swagger-codegen": "node ./node_modules/ts-node/dist/bin.js ./node_modules/swagger-jsonapi-codegen/build-typescript.js -i ./documentation/build/swagger.json -o ./src/app/api/ -u https://www.yourdomain.com"