+
-[Click here to see the comparison](https://htmlpreview.github.io/?https://github.com/ferdikoomen/openapi-typescript-codegen/blob/master/samples/index.html)
+[npm-url]: https://npmjs.org/package/openapi-typescript-codegen
+[npm-image]: https://img.shields.io/npm/v/openapi-typescript-codegen.svg
+[license-url]: LICENSE
+[license-image]: http://img.shields.io/npm/l/openapi-typescript-codegen.svg
+[coverage-url]: https://codecov.io/gh/ferdikoomen/openapi-typescript-codegen
+[coverage-image]: https://img.shields.io/codecov/c/github/ferdikoomen/openapi-typescript-codegen.svg
+[downloads-url]: http://npm-stat.com/charts.html?package=openapi-typescript-codegen
+[downloads-image]: http://img.shields.io/npm/dm/openapi-typescript-codegen.svg
+[build-url]: https://circleci.com/gh/ferdikoomen/openapi-typescript-codegen/tree/main
+[build-image]: https://circleci.com/gh/ferdikoomen/openapi-typescript-codegen/tree/main.svg?style=svg
diff --git a/babel.config.json b/babel.config.json
new file mode 100644
index 000000000..d452c89bd
--- /dev/null
+++ b/babel.config.json
@@ -0,0 +1,18 @@
+{
+ "presets": [
+ [
+ "@babel/preset-env",
+ {
+ "targets": {
+ "node": "12"
+ }
+ }
+ ],
+ [
+ "@babel/preset-typescript",
+ {
+ "onlyRemoveTypeImports": true
+ }
+ ]
+ ]
+}
diff --git a/bin/index.js b/bin/index.js
index aa2cfbed8..32f2fecbc 100755
--- a/bin/index.js
+++ b/bin/index.js
@@ -3,35 +3,48 @@
'use strict';
const path = require('path');
-const program = require('commander');
+const { program } = require('commander');
const pkg = require('../package.json');
-program
+const params = program
+ .name('openapi')
+ .usage('[options]')
.version(pkg.version)
- .option('-i, --input
-
-
-
-
-
-
-
-
-
-
-
diff --git a/samples/package.json b/samples/package.json
deleted file mode 100644
index b29631c40..000000000
--- a/samples/package.json
+++ /dev/null
@@ -1,25 +0,0 @@
-{
- "name": "compare",
- "version": "1.0.0",
- "description": "Package file to compare generated libraries.",
- "license": "MIT",
- "scripts": {
- "build": "tsc"
- },
- "devDependencies": {
- "@angular/common": "9.1.11",
- "@angular/core": "9.1.11",
- "@types/bluebird": "3.5.32",
- "@types/jquery": "3.3.38",
- "@types/node": "14.0.13",
- "@types/request": "2.48.5",
- "aurelia-framework": "1.3.1",
- "aurelia-http-client": "1.3.1",
- "bluebird": "3.7.2",
- "jquery": "3.5.1",
- "request": "2.88.2",
- "rxjs": "6.5.5",
- "rxjs-compat": "6.5.5",
- "typescript": "3.9.5"
- }
-}
diff --git a/samples/v2/spec.json b/samples/spec/v2.json
similarity index 99%
rename from samples/v2/spec.json
rename to samples/spec/v2.json
index 0869e8d29..46b4183ac 100644
--- a/samples/v2/spec.json
+++ b/samples/spec/v2.json
@@ -978,6 +978,13 @@
"Order": {
"type": "object",
"properties": {
+ "bool": {
+ "description": "Simple boolean enum",
+ "type": "boolean",
+ "enum": [
+ true
+ ]
+ },
"id": {
"type": "integer",
"format": "int64"
diff --git a/samples/v3/spec.json b/samples/spec/v3.json
similarity index 99%
rename from samples/v3/spec.json
rename to samples/spec/v3.json
index 7c39dde22..120239692 100644
--- a/samples/v3/spec.json
+++ b/samples/spec/v3.json
@@ -2,7 +2,7 @@
"openapi": "3.0.2",
"info": {
"title": "Swagger Petstore - OpenAPI 3.0",
- "description": "This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about\nSwagger at [http://swagger.io](http://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!\nYou can now help us improve the API whether it's by making changes to the definition itself or to the code.\nThat way, with time, we can improve the API in general, and expose some of the new features in OAS3.\n\nSome useful links:\n- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)\n- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml) ",
+ "description": "This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about\nSwagger at [http://swagger.io](http://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!\nYou can now help us improve the API whether it's by making changes to the definition itself or to the code.\nThat way, with time, we can improve the API in general, and expose some of the new features in OAS3.\n\nSome useful links:\n- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)\n- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/main/src/main/resources/openapi.yaml) ",
"termsOfService": "http://swagger.io/terms/",
"contact": {
"email": "apiteam@swagger.io"
diff --git a/samples/tsconfig.json b/samples/tsconfig.json
deleted file mode 100644
index 8d04b4dcb..000000000
--- a/samples/tsconfig.json
+++ /dev/null
@@ -1,39 +0,0 @@
-{
- "compileOnSave": false,
-
- "compilerOptions": {
- "target": "ES2017",
- "module": "ES6",
- "moduleResolution": "Node",
- "lib": ["ES2017", "DOM"],
- "types": ["node"],
- "typeRoots": ["node_modules/@types"],
- "noImplicitReturns": true,
- "noImplicitThis": true,
- "noImplicitAny": true,
- "skipLibCheck": true,
- "strict": true,
- "strictNullChecks": true,
- "strictFunctionTypes": true,
- "removeComments": true,
- "experimentalDecorators": true
- },
-
- "include": [
- "./examples/v2/openapi-typescript-codegen/**/*.ts",
- "./examples/v2/typescript-angular/**/*.ts",
- "./examples/v2/typescript-aurelia/**/*.ts",
- "./examples/v2/typescript-fetch/**/*.ts",
- "./examples/v2/typescript-inversify/**/*.ts",
- "./examples/v2/typescript-jquery/**/*.ts",
- "./examples/v2/typescript-node/**/*.ts",
- "./examples/v3/openapi-typescript-codegen/**/*.ts",
- "./examples/v3/typescript-angular/**/*.ts",
- "./examples/v3/typescript-fetch/**/*.ts"
- ],
-
- "exclude": [
- "node_modules"
- ]
-}
-
diff --git a/src/HttpClient.ts b/src/HttpClient.ts
new file mode 100644
index 000000000..40c77c7c9
--- /dev/null
+++ b/src/HttpClient.ts
@@ -0,0 +1,7 @@
+export enum HttpClient {
+ FETCH = 'fetch',
+ XHR = 'xhr',
+ NODE = 'node',
+ AXIOS = 'axios',
+ ANGULAR = 'angular',
+}
diff --git a/src/Indent.ts b/src/Indent.ts
new file mode 100644
index 000000000..4203f34c5
--- /dev/null
+++ b/src/Indent.ts
@@ -0,0 +1,5 @@
+export enum Indent {
+ SPACE_4 = '4',
+ SPACE_2 = '2',
+ TAB = 'tab',
+}
diff --git a/src/client/interfaces/Client.d.ts b/src/client/interfaces/Client.d.ts
index 59d0c7683..844e2c6f1 100644
--- a/src/client/interfaces/Client.d.ts
+++ b/src/client/interfaces/Client.d.ts
@@ -1,5 +1,5 @@
-import { Model } from './Model';
-import { Service } from './Service';
+import type { Model } from './Model';
+import type { Service } from './Service';
export interface Client {
version: string;
diff --git a/src/client/interfaces/Model.d.ts b/src/client/interfaces/Model.d.ts
index 13e722cb1..5f0318942 100644
--- a/src/client/interfaces/Model.d.ts
+++ b/src/client/interfaces/Model.d.ts
@@ -1,20 +1,18 @@
-import { Enum } from './Enum';
-import { Schema } from './Schema';
+import type { Enum } from './Enum';
+import type { Schema } from './Schema';
export interface Model extends Schema {
name: string;
- export: 'reference' | 'generic' | 'enum' | 'array' | 'dictionary' | 'interface';
+ export: 'reference' | 'generic' | 'enum' | 'array' | 'dictionary' | 'interface' | 'one-of' | 'any-of' | 'all-of';
type: string;
base: string;
template: string | null;
link: Model | null;
description: string | null;
+ deprecated?: boolean;
default?: string;
imports: string[];
- extends: string[];
enum: Enum[];
enums: Model[];
properties: Model[];
- extendedFrom?: string[];
- extendedBy?: string[];
}
diff --git a/src/client/interfaces/ModelComposition.d.ts b/src/client/interfaces/ModelComposition.d.ts
new file mode 100644
index 000000000..f17fc5e64
--- /dev/null
+++ b/src/client/interfaces/ModelComposition.d.ts
@@ -0,0 +1,8 @@
+import type { Model } from './Model';
+
+export interface ModelComposition {
+ type: 'one-of' | 'any-of' | 'all-of';
+ imports: string[];
+ enums: Model[];
+ properties: Model[];
+}
diff --git a/src/client/interfaces/Operation.d.ts b/src/client/interfaces/Operation.d.ts
index 59fb7371f..779144325 100644
--- a/src/client/interfaces/Operation.d.ts
+++ b/src/client/interfaces/Operation.d.ts
@@ -1,6 +1,6 @@
-import { OperationError } from './OperationError';
-import { OperationParameters } from './OperationParameters';
-import { OperationResponse } from './OperationResponse';
+import type { OperationError } from './OperationError';
+import type { OperationParameters } from './OperationParameters';
+import type { OperationResponse } from './OperationResponse';
export interface Operation extends OperationParameters {
service: string;
diff --git a/src/client/interfaces/OperationParameter.d.ts b/src/client/interfaces/OperationParameter.d.ts
index 0fea37466..77c0da771 100644
--- a/src/client/interfaces/OperationParameter.d.ts
+++ b/src/client/interfaces/OperationParameter.d.ts
@@ -1,6 +1,7 @@
-import { Model } from './Model';
+import type { Model } from './Model';
export interface OperationParameter extends Model {
in: 'path' | 'query' | 'header' | 'formData' | 'body' | 'cookie';
prop: string;
+ mediaType: string | null;
}
diff --git a/src/client/interfaces/OperationParameters.d.ts b/src/client/interfaces/OperationParameters.d.ts
index b2e0240f5..43419438c 100644
--- a/src/client/interfaces/OperationParameters.d.ts
+++ b/src/client/interfaces/OperationParameters.d.ts
@@ -1,4 +1,4 @@
-import { OperationParameter } from './OperationParameter';
+import type { OperationParameter } from './OperationParameter';
export interface OperationParameters {
imports: string[];
diff --git a/src/client/interfaces/OperationResponse.d.ts b/src/client/interfaces/OperationResponse.d.ts
index afdb668ca..0eed91537 100644
--- a/src/client/interfaces/OperationResponse.d.ts
+++ b/src/client/interfaces/OperationResponse.d.ts
@@ -1,4 +1,4 @@
-import { Model } from './Model';
+import type { Model } from './Model';
export interface OperationResponse extends Model {
in: 'response' | 'header';
diff --git a/src/client/interfaces/Schema.d.ts b/src/client/interfaces/Schema.d.ts
index b45158d9f..26a116dbf 100644
--- a/src/client/interfaces/Schema.d.ts
+++ b/src/client/interfaces/Schema.d.ts
@@ -3,7 +3,18 @@ export interface Schema {
isReadOnly: boolean;
isRequired: boolean;
isNullable: boolean;
- format?: 'int32' | 'int64' | 'float' | 'double' | 'string' | 'boolean' | 'byte' | 'binary' | 'date' | 'date-time' | 'password';
+ format?:
+ | 'int32'
+ | 'int64'
+ | 'float'
+ | 'double'
+ | 'string'
+ | 'boolean'
+ | 'byte'
+ | 'binary'
+ | 'date'
+ | 'date-time'
+ | 'password';
maximum?: number;
exclusiveMaximum?: boolean;
minimum?: number;
diff --git a/src/client/interfaces/Service.d.ts b/src/client/interfaces/Service.d.ts
index f7861cd2c..9ab21ebee 100644
--- a/src/client/interfaces/Service.d.ts
+++ b/src/client/interfaces/Service.d.ts
@@ -1,4 +1,4 @@
-import { Operation } from './Operation';
+import type { Operation } from './Operation';
export interface Service {
name: string;
diff --git a/src/client/interfaces/Type.d.ts b/src/client/interfaces/Type.d.ts
index 5445eea5f..114c68b63 100644
--- a/src/client/interfaces/Type.d.ts
+++ b/src/client/interfaces/Type.d.ts
@@ -3,4 +3,5 @@ export interface Type {
base: string;
template: string | null;
imports: string[];
+ isNullable: boolean;
}
diff --git a/src/index.spec.ts b/src/index.spec.ts
index 224e660fb..ff7bd155a 100644
--- a/src/index.spec.ts
+++ b/src/index.spec.ts
@@ -1,38 +1,34 @@
-import * as OpenAPI from '.';
+import OpenAPI from './index';
describe('index', () => {
it('parses v2 without issues', async () => {
await OpenAPI.generate({
- input: './test/mock/v2/spec.json',
- output: './test/result/v2/',
- useOptions: true,
- useUnionTypes: true,
+ input: './test/spec/v2.json',
+ output: './generated/v2/',
write: false,
});
});
it('parses v3 without issues', async () => {
await OpenAPI.generate({
- input: './test/mock/v3/spec.json',
- output: './test/result/v3/',
- useOptions: true,
- useUnionTypes: true,
+ input: './test/spec/v3.json',
+ output: './generated/v3/',
write: false,
});
});
it('downloads and parses v2 without issues', async () => {
await OpenAPI.generate({
- input: 'https://raw.githubusercontent.com/ferdikoomen/openapi-typescript-codegen/master/test/mock/v2/spec.json',
- output: './test/result/v22/',
+ input: 'https://raw.githubusercontent.com/ferdikoomen/openapi-typescript-codegen/main/test/spec/v2.json',
+ output: './generated/v2-downloaded/',
write: false,
});
});
it('downloads and parses v3 without issues', async () => {
await OpenAPI.generate({
- input: 'https://raw.githubusercontent.com/ferdikoomen/openapi-typescript-codegen/master/test/mock/v3/spec.json',
- output: './test/result/v33/',
+ input: 'https://raw.githubusercontent.com/ferdikoomen/openapi-typescript-codegen/main/test/spec/v3.json',
+ output: './generated/v3-downloaded/',
write: false,
});
});
diff --git a/src/index.ts b/src/index.ts
index 191183596..e63919085 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -1,3 +1,5 @@
+import { HttpClient } from './HttpClient';
+import { Indent } from './Indent';
import { parse as parseV2 } from './openApi/v2';
import { parse as parseV3 } from './openApi/v3';
import { getOpenApiSpec } from './utils/getOpenApiSpec';
@@ -7,74 +9,124 @@ import { postProcessClient } from './utils/postProcessClient';
import { registerHandlebarTemplates } from './utils/registerHandlebarTemplates';
import { writeClient } from './utils/writeClient';
-export enum HttpClient {
- FETCH = 'fetch',
- XHR = 'xhr',
-}
+export { HttpClient } from './HttpClient';
+export { Indent } from './Indent';
-export interface Options {
+export type Options = {
input: string | RecordCompared to other generators
-- Depending on which swagger generator you use, you will see different output. For instance: - Different ways of generating models, services, level of quality, HTTP client, etc. - I've compiled a list below with the results per area and how they compare - against the openapi-typescript-codegen. -
-I've used the standard petshop examples from OpenAPI:
- --
And used the following generators with their default options:
--
-
- typescript-aurelia -
- typescript-angular -
- typescript-inversify -
- typescript-angular -
- typescript-fetch -
- typescript-jquery -
- typescript-node -
-
| - | openapi-typescript-codegen | -aurelia | -inversify | -angular | -fetch | -jquery | -node | -
|---|---|---|---|---|---|---|---|
| Supports OpenApi v2 specification | -✅ | -✅ | -✅ | -✅ | -✅ | -✅ | -✅ | -
| Supports OpenApi v3 specification | -✅ | -❌ | -❌ | -✅ | -✅ | -❌ | -❌ | -
| Supports authentication | -✅ | -❌ | -✅ | -✅ | -✅ | -✅ | -✅ | -
| Strongly typed models | -✅ | -✅ | -✅ | -✅ | -✅ | -✅ | -✅ | -
| Strongly typed enums | -✅ | -✅ | -✅ | -✅ | -✅ | -✅ | -✅ | -
| Models and services exported as individual files | -✅ | -❌ | -✅ | -✅ | -❌ | -✅ | -❌ | -
| Index file that exports all services and models | -✅ | -✅ | -❌ | -✅ | -✅ | -✅ | -❌ | -
| Service returns typed result | -✅ | -✅ | -✅ | -✅ | -❌ | -✅ | -✅ | -
| Service supports sending and receiving binary content | -✅ | -✅ | -✅ | -
- ⚠️
-
-
- Details-V3 version sends data as |
-
- ⚠️
-
-
- Details-V3 version sends data as |
- ✅ | -✅ | -
| Models and services contain inline documentation | -✅ | -✅ | -✅ | -✅ | -✅ | -✅ | -✅ | -
| Framework agnostic | -✅ | -❌ | -❌ | -❌ | -
- ⚠️
-
-
- Details-Requires portable-fetch - |
- ❌ | -
- ⚠️
-
-
- Details-Requires bluebird - |
-
| Compiles in strict mode without issues | -✅ | -
- ❌
-
-
- Details-Errors when compiling: |
-
- ❌
-
-
- Details-Errors when compiling: |
-
- ❌
-
-
- Details-Errors when compiling: |
-
- ❌
-
-
- Details-Errors when compiling: |
-
- ❌
-
-
- Details-Errors when compiling: |
-
- ❌
-
-
- Details-Errors when compiling: |
-
| Generated size (typescript) | -30KB | -29KB | -37KB | -63KB | -85KB | -57KB | -65KB | -
| Build size (javascript, not minimized) | -17KB | -16KB | -22KB | -36KB | -48KB | -37KB | -53KB | -
| Generation time | -0.132s | -0.715s | -0.788s | -1.386s | -1.103s | -0.728s | -0.752s | -