Skip to content
This repository was archived by the owner on Feb 10, 2023. It is now read-only.

Commit 13c233f

Browse files
HimenonHimenon
authored
chore: fix bugs and update docs (Himenon#6)
* fix: example * docs: add playground * fix: additionalProperties bugs * fix: add typeAlias description
1 parent 20d8289 commit 13c233f

File tree

12 files changed

+102
-103
lines changed

12 files changed

+102
-103
lines changed

‎README.md

+2
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ The hierarchical structure of the directory is converted to the hierarchical str
99

1010
## Usage
1111

12+
- [Playground](https://himenon.github.io/openapi-typescript-code-generator-playground/index.html)
13+
1214
## Installation
1315

1416
```bash

‎docs/ja/README-ja.md

+2
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77

88
## 使い方
99

10+
- [Playground](https://himenon.github.io/openapi-typescript-code-generator-playground/index.html)
11+
1012
### インストール
1113

1214
```bash

‎example/sample-axios.ts

+2-18
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,14 @@
1-
import * as Formatter from "@himenon/openapi-parameter-formatter";
21
import * as axios from "axios";
32

43
import { ApiClient, Client, HttpMethod, ObjectLike, QueryParameters } from "./client";
4+
import { generateQueryString } from "./utils";
55

66
export interface RequestOption {
77
retries?: number;
88
timeout?: number;
99
deadline?: number;
1010
}
1111

12-
const generateQueryString = (queryParameters: QueryParameters | undefined): string | undefined => {
13-
if (!queryParameters) {
14-
return undefined;
15-
}
16-
return Object.entries(queryParameters).reduce((queryString, [key, item]) => {
17-
if (!item.style) {
18-
return queryString + "&" + `${key}=${item}`;
19-
}
20-
const result = Formatter.QueryParameter.generate(key, item as Formatter.QueryParameter.Parameter);
21-
if (result) {
22-
return queryString + "&" + result;
23-
}
24-
return queryString;
25-
}, "");
26-
};
27-
2812
const convertHttpMethodToAxiosMethod = (httpMethod: HttpMethod): axios.Method => {
2913
const patterns: { [key in HttpMethod]: axios.Method } = {
3014
GET: "GET",
@@ -49,7 +33,7 @@ const apiClientImpl: ApiClient<RequestOption> = {
4933
options?: RequestOption,
5034
): Promise<any> => {
5135
const query = generateQueryString(queryParameters);
52-
const requestUrl = query ? url + "&" + query : url;
36+
const requestUrl = query ? url + "?" + encodeURI(query) : url;
5337
const response = await axios.default.request({
5438
url: requestUrl,
5539
method: convertHttpMethodToAxiosMethod(httpMethod),

‎example/sample-debug.ts

+2-19
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,10 @@
1-
import * as Formatter from "@himenon/openapi-parameter-formatter";
2-
31
import { ApiClient, Client, HttpMethod, ObjectLike, QueryParameters } from "./client";
2+
import { generateQueryString } from "./utils";
43

54
export interface RequestOption {
65
timeout?: number;
76
}
87

9-
const generateQueryString = (queryParameters: QueryParameters | undefined): string | undefined => {
10-
if (!queryParameters) {
11-
return undefined;
12-
}
13-
return Object.entries(queryParameters).reduce((queryString, [key, item]) => {
14-
if (!item.style) {
15-
return queryString + "&" + `${key}=${item}`;
16-
}
17-
const result = Formatter.QueryParameter.generate(key, item as Formatter.QueryParameter.Parameter);
18-
if (result) {
19-
return queryString + "&" + result;
20-
}
21-
return queryString;
22-
}, "");
23-
};
24-
258
const apiClientImpl: ApiClient<RequestOption> = {
269
request: async (
2710
httpMethod: HttpMethod,
@@ -32,7 +15,7 @@ const apiClientImpl: ApiClient<RequestOption> = {
3215
options?: RequestOption,
3316
): Promise<any> => {
3417
const query = generateQueryString(queryParameters);
35-
const requestUrl = query ? url + "&" + query : url;
18+
const requestUrl = query ? url + "?" + encodeURI(query) : url;
3619
console.log({
3720
httpMethod,
3821
url,

‎example/sample-fetch.ts

+3-19
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,12 @@
1-
import * as Formatter from "@himenon/openapi-parameter-formatter";
21
import fetch from "node-fetch";
32

43
import { ApiClient, Client, HttpMethod, ObjectLike, QueryParameters } from "./client";
4+
import { generateQueryString } from "./utils";
55

66
export interface RequestOption {
77
timeout?: number;
88
}
99

10-
const generateQueryString = (queryParameters: QueryParameters | undefined): string | undefined => {
11-
if (!queryParameters) {
12-
return undefined;
13-
}
14-
return Object.entries(queryParameters).reduce((queryString, [key, item]) => {
15-
if (!item.style) {
16-
return queryString + "&" + `${key}=${item}`;
17-
}
18-
const result = Formatter.QueryParameter.generate(key, item as Formatter.QueryParameter.Parameter);
19-
if (result) {
20-
return queryString + "&" + result;
21-
}
22-
return queryString;
23-
}, "");
24-
};
25-
2610
const apiClientImpl: ApiClient<RequestOption> = {
2711
request: async (
2812
httpMethod: HttpMethod,
@@ -33,9 +17,9 @@ const apiClientImpl: ApiClient<RequestOption> = {
3317
options?: RequestOption,
3418
): Promise<any> => {
3519
const query = generateQueryString(queryParameters);
36-
const requestUrl = query ? url + "&" + query : url;
20+
const requestUrl = query ? url + "?" + encodeURI(query) : url;
3721
const response = await fetch(requestUrl, {
38-
body: requestBody,
22+
body: JSON.stringify(requestBody),
3923
headers,
4024
method: httpMethod,
4125
timeout: options?.timeout,

‎example/sample-superagent.ts

+2-18
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,14 @@
1-
import * as Formatter from "@himenon/openapi-parameter-formatter";
21
import * as Superagent from "superagent";
32

43
import { ApiClient, Client, HttpMethod, ObjectLike, QueryParameters } from "./client";
4+
import { generateQueryString } from "./utils";
55

66
export interface RequestOption {
77
retries?: number;
88
timeout?: number;
99
deadline?: number;
1010
}
1111

12-
const generateQueryString = (queryParameters: QueryParameters | undefined): string | undefined => {
13-
if (!queryParameters) {
14-
return undefined;
15-
}
16-
return Object.entries(queryParameters).reduce((queryString, [key, item]) => {
17-
if (!item.style) {
18-
return queryString + "&" + `${key}=${item}`;
19-
}
20-
const result = Formatter.QueryParameter.generate(key, item as Formatter.QueryParameter.Parameter);
21-
if (result) {
22-
return queryString + "&" + result;
23-
}
24-
return queryString;
25-
}, "");
26-
};
27-
2812
const apiClientImpl: ApiClient<RequestOption> = {
2913
request: (
3014
httpMethod: HttpMethod,
@@ -35,7 +19,7 @@ const apiClientImpl: ApiClient<RequestOption> = {
3519
options?: RequestOption,
3620
): Promise<any> => {
3721
const query = generateQueryString(queryParameters);
38-
const requestUrl = query ? url + "&" + query : url;
22+
const requestUrl = query ? url + "?" + encodeURI(query) : url;
3923

4024
return new Promise((resolve, reject) => {
4125
const agent = Superagent;

‎example/utils.ts

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
import * as Formatter from "@himenon/openapi-parameter-formatter";
2+
3+
import { QueryParameters } from "./client";
4+
5+
export const generateQueryString = (queryParameters: QueryParameters | undefined): string | undefined => {
6+
if (!queryParameters) {
7+
return undefined;
8+
}
9+
const queries = Object.entries(queryParameters).reduce<string[]>((queryStringList, [key, item]) => {
10+
if (!item.value) {
11+
return queryStringList;
12+
}
13+
if (!item.style) {
14+
return queryStringList.concat(`${key}=${item.value}`);
15+
}
16+
const result = Formatter.QueryParameter.generate(key, item as Formatter.QueryParameter.Parameter);
17+
if (result) {
18+
return queryStringList.concat(result);
19+
}
20+
return queryStringList;
21+
}, []);
22+
23+
return queries.join("&");
24+
};

‎src/Converter/v3/components/Schema.ts

+1
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ export const generateTypeAlias = (
109109
export: true,
110110
name,
111111
type,
112+
comment: schema.description,
112113
});
113114
};
114115

‎src/Converter/v3/components/Schemas.ts

+1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ export const generateNamespace = (
5656
value: factory.TypeAliasDeclaration.create({
5757
export: true,
5858
name: name,
59+
comment: reference.data.description,
5960
type: factory.TypeReferenceNode.create({
6061
name: context.getReferenceName(currentPoint, reference.path),
6162
}),

‎src/Converter/v3/toTypeNode.ts

+21-29
Original file line numberDiff line numberDiff line change
@@ -175,44 +175,36 @@ export const convert: Convert = (
175175
return nullable(factory, typeNode, !!schema.nullable);
176176
}
177177
case "object": {
178-
if (!schema.properties) {
179-
return factory.TypeNode.create({
180-
type: "object",
181-
value: [],
182-
});
183-
}
184-
let typeNode: ts.TypeNode;
185178
const required: string[] = schema.required || [];
186-
// https://swagger.io/docs/specification/data-models/dictionaries/#free-form
179+
// // https://swagger.io/docs/specification/data-models/dictionaries/#free-form
187180
if (schema.additionalProperties === true) {
188-
typeNode = factory.TypeNode.create({
181+
return factory.TypeNode.create({
189182
type: schema.type,
190183
value: [],
191184
});
192-
} else {
193-
const value: ts.PropertySignature[] = Object.entries(schema.properties).map(([name, jsonSchema]) => {
194-
return factory.PropertySignature.create({
195-
name,
196-
type: convert(entryPoint, currentPoint, factory, jsonSchema, context, { parent: schema.properties }),
197-
optional: !required.includes(name),
198-
comment: typeof jsonSchema !== "boolean" ? jsonSchema.description : undefined,
199-
});
185+
}
186+
const value: ts.PropertySignature[] = Object.entries(schema.properties || {}).map(([name, jsonSchema]) => {
187+
return factory.PropertySignature.create({
188+
name,
189+
type: convert(entryPoint, currentPoint, factory, jsonSchema, context, { parent: schema.properties }),
190+
optional: !required.includes(name),
191+
comment: typeof jsonSchema !== "boolean" ? jsonSchema.description : undefined,
200192
});
201-
if (schema.additionalProperties) {
202-
const additionalProperties = factory.IndexSignatureDeclaration.create({
203-
name: "key",
204-
type: convert(entryPoint, currentPoint, factory, schema.additionalProperties, context, { parent: schema.properties }),
205-
});
206-
return factory.TypeNode.create({
207-
type: schema.type,
208-
value: [...value, additionalProperties],
209-
});
210-
}
211-
typeNode = factory.TypeNode.create({
193+
});
194+
if (schema.additionalProperties) {
195+
const additionalProperties = factory.IndexSignatureDeclaration.create({
196+
name: "key",
197+
type: convert(entryPoint, currentPoint, factory, schema.additionalProperties, context, { parent: schema.properties }),
198+
});
199+
return factory.TypeNode.create({
212200
type: schema.type,
213-
value,
201+
value: [...value, additionalProperties],
214202
});
215203
}
204+
const typeNode = factory.TypeNode.create({
205+
type: schema.type,
206+
value,
207+
});
216208
return nullable(factory, typeNode, !!schema.nullable);
217209
}
218210
default:

‎test/__tests__/__snapshots__/snapshot-test.ts.snap

+19
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ exports[`Generate Code Snapshot Test api.test.domain 1`] = `
1212
1313
/** @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#schemaObject */
1414
export namespace Schemas {
15+
/** String Literal */
1516
export type StringType = string;
1617
export type StringHasEnumType = \\"a\\" | \\"A\\" | \\"b\\" | \\"B\\" | \\"c\\" | \\"C\\";
1718
export type StringDateType = string;
@@ -20,12 +21,14 @@ export namespace Schemas {
2021
export type StringByteType = string;
2122
export type StringBinaryType = string;
2223
export type StringWithPatternType = string;
24+
/** Number Literal */
2325
export type NumberType = number;
2426
export type NumberHasEnumType = 1 | 2 | 3 | 100 | 123 | 0.1 | -0.1 | 0;
2527
export type NumberInt32Type = number;
2628
export type NumberInt64Type = number;
2729
export type NumberFloat = number;
2830
export type NumberDouble = number;
31+
/** Boolean Literal */
2932
export type BooleanType = boolean;
3033
export type ArrayStringType = string[];
3134
export type ArrayNumberType = number[];
@@ -64,8 +67,10 @@ export namespace Schemas {
6467
export type RemoteString = string;
6568
export type RemoteRefString = Schemas.RemoteString;
6669
export namespace Level1 {
70+
/** Level 1 */
6771
export type RemoteBoolean = boolean;
6872
export namespace Level2 {
73+
/** Level 2 */
6974
export type RemoteNumber = number;
7075
export namespace Level3 {
7176
/** Level 3 */
@@ -80,9 +85,13 @@ export namespace Schemas {
8085
}
8186
}
8287
}
88+
/** Level 1 */
8389
export type RemoteRefBoolean = Schemas.Level1.RemoteBoolean;
90+
/** Level 2 */
8491
export type RemoteRefNumber = Schemas.Level1.Level2.RemoteNumber;
92+
/** Level 3 */
8593
export type RemoteRefArray = Schemas.Level1.Level2.Level3.RemoteArray;
94+
/** Level 4 */
8695
export type RemoteRefObject = Schemas.Level1.Level2.Level3.Level4.RemoteObject;
8796
export namespace DirectRef {
8897
export type ForHeader = string;
@@ -218,6 +227,16 @@ export namespace Parameters {
218227
export type RemoteReferenceB = Parameters.level1.B;
219228
/** parameters -> schemas */
220229
export type ReferenceOfParameterToSchema = Schemas.DirectRef.ForParameters;
230+
/** deepObject */
231+
export type DeepObjectParameter = {
232+
[key: string]: {
233+
gt?: string;
234+
gte?: string;
235+
lt?: string;
236+
lte?: string;
237+
any?: string | number | boolean;
238+
};
239+
};
221240
}
222241
/** @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#componentsObject */
223242
export namespace RequestBodies {

‎test/api.test.domain/index.yml

+23
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,29 @@ components:
205205
name: ForReference
206206
schema:
207207
$ref: "./components/schemas/DirectRef/ForParameters.yml"
208+
DeepObjectParameter:
209+
description: deepObject
210+
required: true
211+
in: query
212+
name: filter
213+
schema:
214+
type: object
215+
additionalProperties:
216+
type: object
217+
properties:
218+
gt:
219+
type: string
220+
gte:
221+
type: string
222+
lt:
223+
type: string
224+
lte:
225+
type: string
226+
any:
227+
oneOf:
228+
- type: string
229+
- type: number
230+
- type: boolean
208231
responses:
209232
Continue:
210233
description: |

0 commit comments

Comments
 (0)