{"id":17645073,"url":"https://github.com/ikemtz/openapi-ts-generator","last_synced_at":"2025-05-06T21:06:06.456Z","repository":{"id":36933006,"uuid":"231400862","full_name":"ikemtz/openapi-ts-generator","owner":"ikemtz","description":"NPM package based on swagger-ts-generator to generate typescript models for endpoints documented by swagger using the relatively new OpenAPI spec.","archived":false,"fork":false,"pushed_at":"2025-04-25T16:39:46.000Z","size":1788,"stargazers_count":8,"open_issues_count":2,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-06T21:05:40.449Z","etag":null,"topics":["angular","openapi-codegen","openapi3","typescript-generator","typescript-models"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ikemtz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-01-02T14:43:45.000Z","updated_at":"2025-04-25T16:37:42.000Z","dependencies_parsed_at":"2023-01-17T07:19:10.635Z","dependency_job_id":"9f34660c-6e46-4906-9f94-87f01d518c1e","html_url":"https://github.com/ikemtz/openapi-ts-generator","commit_stats":{"total_commits":362,"total_committers":7,"mean_commits":"51.714285714285715","dds":0.3674033149171271,"last_synced_commit":"76b75c6a4c7dfd63918819e1523a6f4266989f67"},"previous_names":[],"tags_count":292,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ikemtz%2Fopenapi-ts-generator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ikemtz%2Fopenapi-ts-generator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ikemtz%2Fopenapi-ts-generator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ikemtz%2Fopenapi-ts-generator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ikemtz","download_url":"https://codeload.github.com/ikemtz/openapi-ts-generator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252769396,"owners_count":21801376,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","openapi-codegen","openapi3","typescript-generator","typescript-models"],"created_at":"2024-10-23T10:46:28.112Z","updated_at":"2025-05-06T21:06:06.432Z","avatar_url":"https://github.com/ikemtz.png","language":"TypeScript","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\u0026branchName=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\u0026metric=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\u0026metric=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\u0026metric=ncloc)](https://sonarcloud.io/dashboard?id=ikemtz_openapi-ts-generator) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=ikemtz_openapi-ts-generator\u0026metric=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)\n\n# OpenApi-TS-Generator\n\nNPM 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/).\n\n## TypeScript usage with a hosted OpenApi Spec document.\n\n```javascript\nimport { generateTsModels } from 'openapi-ts-generator';\n\ngenerateTsModels({\n  openApiJsonUrl: '{Your Swagger Enpoint URL here}',\n  outputPath: './{outputFolder}/',\n});\n```\n\n## TypeScript usage with an OpenApi Spec document stored on your local computer.\n\n```javascript\nimport { generateTsModels } from 'openapi-ts-generator';\n\ngenerateTsModels({\n  openApiJsonFileName: '{location and file name of your OpenApi document}',\n  outputPath: './{outputFolder}/',\n});\n```\n\n## Javascript usage with a hosted OpenApi Spec document.\n\n```javascript\nconst generator = require('openapi-ts-generator');\n\ngenerator.generateTsModels({\n  openApiJsonUrl: '{Your Swagger Enpoint URL here}',\n  outputPath: './{outputFolder}/',\n  genAngularFormGroups: true /* Set this to true if only if you're in an Angular project*/\n});\n```\n\n## Javascript usage with an OpenApi Spec document stored on your local computer.\n\n```javascript\nconst generator = require('openapi-ts-generator');\n\ngenerator.generateTsModels({\n  openApiJsonFileName: '{location and file name of your OpenApi document}',\n  outputPath: './{outputFolder}/',\n});\n```\n\n## Want to include Angular FormGroup Factories?\n\n```javascript\nconst generator = require('openapi-ts-generator');\n\ngenerator.generateTsModels({\n  openApiJsonFileName: '{location and file name of your OpenApi document}',\n  outputPath: './{outputFolder}/',\n  genAngularFormGroups: true\n});\n```\n\n## Working example with NRSRx based service\n\n```javascript\nimport { generateTsModels } from 'openapi-ts-generator';\n\ngenerateTsModels({\n  openApiJsonUrl: 'https://im-wa-cmpo-nrsr.azurewebsites.net/swagger/v1/swagger.json',\n  outputPath: './models/',\n  typeFilterCallBack: (val, i, arr) =\u003e !val.name.endsWith('ODataEnvelope'),\n  valuePropertyTypeFilterCallBack: (val, i, arr) =\u003e !val.name.startsWith('created') \u0026\u0026 !val.name.startsWith('updated'),\n});\n```\n\nCheck out [openapi-mermaid](https://www.npmjs.com/package/openapi-mermaid), it will auto-generate mermaid entity diagrams using your swagger docs.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fikemtz%2Fopenapi-ts-generator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fikemtz%2Fopenapi-ts-generator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fikemtz%2Fopenapi-ts-generator/lists"}