https://github.com/ikemtz/openapi-ts-generator

NPM package based on swagger-ts-generator to generate typescript models for endpoints documented by swagger using the relatively new OpenAPI spec.
https://github.com/ikemtz/openapi-ts-generator

angular openapi-codegen openapi3 typescript-generator typescript-models

Last synced: 2 months ago
JSON representation

NPM package based on swagger-ts-generator to generate typescript models for endpoints documented by swagger using the relatively new OpenAPI spec.

• Host: GitHub
• URL: https://github.com/ikemtz/openapi-ts-generator
• Owner: ikemtz
• License: mit
• Created: 2020-01-02T14:43:45.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-23T18:54:22.000Z (3 months ago)
• Last Synced: 2024-10-25T16:46:01.324Z (2 months ago)
• Topics: angular, openapi-codegen, openapi3, typescript-generator, typescript-models
• Language: TypeScript
• Homepage:
• Size: 2.05 MB
• Stars: 7
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://ikemtz.visualstudio.com/CI%20CD/_apis/build/status/openapi-ts-generator?branchName=master)](https://ikemtz.visualstudio.com/CI%20CD/_build/latest?definitionId=20&branchName=master) [![npm version](https://badge.fury.io/js/openapi-ts-generator.svg)](https://www.npmjs.com/package/openapi-ts-generator) [![npm downloads](https://img.shields.io/npm/dt/openapi-ts-generator)](https://www.npmjs.com/package/openapi-ts-generator) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ikemtz_openapi-ts-generator&metric=alert_status)](https://sonarcloud.io/dashboard?id=ikemtz_openapi-ts-generator) [![Issues](https://img.shields.io/github/issues-raw/ikemtz/OpenApi-TS-Generator)](https://github.com/ikemtz/openapi-ts-generator/issues) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=ikemtz_openapi-ts-generator&metric=coverage)](https://sonarcloud.io/dashboard?id=ikemtz_openapi-ts-generator) [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=ikemtz_openapi-ts-generator&metric=ncloc)](https://sonarcloud.io/dashboard?id=ikemtz_openapi-ts-generator) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=ikemtz_openapi-ts-generator&metric=security_rating)](https://sonarcloud.io/dashboard?id=ikemtz_openapi-ts-generator) [![CodeQL](https://github.com/ikemtz/openapi-ts-generator/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/ikemtz/openapi-ts-generator/actions/workflows/codeql-analysis.yml)

# OpenApi-TS-Generator

NPM package based on [swagger-ts-generator](https://www.npmjs.com/package/swagger-ts-generator) to generate typescript models for endpoints documented by swagger using the relatively new [OpenAPI spec](https://swagger.io/docs/specification/about/).

## TypeScript usage with a hosted OpenApi Spec document.

```javascript

import { generateTsModels } from 'openapi-ts-generator';

generateTsModels({

  openApiJsonUrl: '{Your Swagger Enpoint URL here}',

  outputPath: './{outputFolder}/',

});

```

## TypeScript usage with an OpenApi Spec document stored on your local computer.

```javascript

import { generateTsModels } from 'openapi-ts-generator';

generateTsModels({

  openApiJsonFileName: '{location and file name of your OpenApi document}',

  outputPath: './{outputFolder}/',

});

```

## Javascript usage with a hosted OpenApi Spec document.

```javascript

const generator = require('openapi-ts-generator');

generator.generateTsModels({

  openApiJsonUrl: '{Your Swagger Enpoint URL here}',

  outputPath: './{outputFolder}/',

  genAngularFormGroups: true /* Set this to true if only if you're in an Angular project*/

});

```

## Javascript usage with an OpenApi Spec document stored on your local computer.

```javascript

const generator = require('openapi-ts-generator');

generator.generateTsModels({

  openApiJsonFileName: '{location and file name of your OpenApi document}',

  outputPath: './{outputFolder}/',

});

```

## Want to include Angular FormGroup Factories?

```javascript

const generator = require('openapi-ts-generator');

generator.generateTsModels({

  openApiJsonFileName: '{location and file name of your OpenApi document}',

  outputPath: './{outputFolder}/',

  genAngularFormGroups: true

});

```

## Working example with NRSRx based service

```javascript

import { generateTsModels } from 'openapi-ts-generator';

generateTsModels({

  openApiJsonUrl: 'https://im-wa-cmpo-nrsr.azurewebsites.net/swagger/v1/swagger.json',

  outputPath: './models/',

  typeFilterCallBack: (val, i, arr) => !val.name.endsWith('ODataEnvelope'),

  valuePropertyTypeFilterCallBack: (val, i, arr) => !val.name.startsWith('created') && !val.name.startsWith('updated'),

});

```

Check out [openapi-mermaid](https://www.npmjs.com/package/openapi-mermaid), it will auto-generate mermaid entity diagrams using your swagger docs.