Skip to content

Commit b5d3d50

Browse files
js2mejs2me
authored
Release 6.1.1 (Bugfix) (acacode#186)
* internal: beatify output for spec tests * docs: update title text in README * bump: 6.1.1 version; fix: --axios, --modular options
1 parent 9621fed commit b5d3d50

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+29245
-75
lines changed

‎CHANGELOG.md

+9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# next release
22

3+
# 6.1.1
4+
5+
Fixes:
6+
- Problems with `--axios` option
7+
- ignoring `path`, `format`, `type` payload properties in `request()` method of `HttpClient`
8+
- Missing `format` property for requests in `--modular` option
9+
10+
# 6.1.0
11+
312
Features:
413
- `--silent` option. Output only errors to console (default: false)
514

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
Generate api via swagger scheme.
1313
Supports OA 3.0, 2.0, JSON, yaml
14-
Generated api module use [**Fetch Api**](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) to make requests.
14+
Generated api module use [**Fetch Api**](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) or [**Axios**](https://github.com/axios/axios) to make requests.
1515

1616
<br>
1717
<br>

‎package-lock.json

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "swagger-typescript-api",
3-
"version": "6.1.0",
3+
"version": "6.1.1",
44
"description": "Create typescript api module from swagger schema",
55
"scripts": {
66
"cli:json": "node index.js -r -d -p ./swagger-test-cli.json -n swagger-test-cli.ts --extract-request-params --enum-names-as-values",
@@ -32,6 +32,7 @@
3232
"test:--js": "node tests/spec/js/test.js",
3333
"test:--js--axios": "node tests/spec/jsAxios/test.js",
3434
"test:--axios": "node tests/spec/axios/test.js",
35+
"test:--axios--single-http-client": "node tests/spec/axiosSingleHttpClient/test.js",
3536
"test:partialBaseTemplate": "node tests/spec/partialBaseTemplate/test.js",
3637
"test:partialDefaultTemplate": "node tests/spec/partialDefaultTemplate/test.js"
3738
},

‎templates/base/http-clients/axios-http-client.eta

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
<%
22
const { apiConfig, generateResponses } = it;
33
%>
4-
import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse } from "axios";
4+
import axios, { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from "axios";
55

66
export type QueryParamsType = Record<string | number, any>;
7-
export type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
87

9-
export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params"> {
8+
export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "params" | "url" | "responseType"> {
109
/** set parameter to `true` for call `securityWorker` for this request */
1110
secure?: boolean;
1211
/** request path */
@@ -16,7 +15,7 @@ export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "pa
1615
/** query params */
1716
query?: QueryParamsType;
1817
/** format of response (i.e. response.json() -> format: "json") */
19-
format?: keyof Omit<Body, "body" | "bodyUsed">;
18+
format?: ResponseType;
2019
/** request body */
2120
body?: unknown;
2221
}
@@ -77,7 +76,9 @@ export class HttpClient<SecurityDataType = unknown> {
7776
...(requestParams.headers || {}),
7877
},
7978
params: query,
79+
responseType: format,
8080
data: body,
81+
url: path,
8182
});
8283
};
8384
}

‎templates/base/http-clients/fetch-http-client.eta

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
1515
/** query params */
1616
query?: QueryParamsType;
1717
/** format of response (i.e. response.json() -> format: "json") */
18-
format?: keyof Omit<Body, "body" | "bodyUsed">;
18+
format?: ResponseFormat;
1919
/** request body */
2020
body?: unknown;
2121
/** base url */

‎templates/default/procedure-call.eta

+2-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ const { type, errorType, contentTypes } = route.response;
77
const routeDocs = includeFile("@base/route-docs", { config, route, utils });
88
const queryName = (query && query.name) || "query";
99
const pathParams = _.values(parameters);
10+
const isFetchTemplate = config.httpClientType === config.constants.HTTP_CLIENT.FETCH;
1011

1112
const requestConfigParam = {
1213
name: pathParams.some((pathArg) => pathArg.name === "params") ? "requestParams" : "params",
@@ -51,7 +52,7 @@ const requestContentKind = {
5152
const responseContentKind = {
5253
"JSON": '"json"',
5354
"IMAGE": '"blob"',
54-
"FORM_DATA": '"formData"'
55+
"FORM_DATA": isFetchTemplate ? '"formData"' : '"document"'
5556
}
5657

5758
const bodyTmpl = _.get(payload, "name") || null;

‎templates/modular/procedure-call.eta

+3-1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ const { type, errorType, contentTypes } = route.response;
77
const routeDocs = includeFile("@base/route-docs", { config, route, utils });
88
const queryName = (query && query.name) || "query";
99
const pathParams = _.values(parameters);
10+
const isFetchTemplate = config.httpClientType === config.constants.HTTP_CLIENT.FETCH;
1011

1112
const requestConfigParam = {
1213
name: pathParams.some((pathArg) => pathArg.name === "params") ? "requestParams" : "params",
@@ -51,7 +52,7 @@ const requestContentKind = {
5152
const responseContentKind = {
5253
"JSON": '"json"',
5354
"IMAGE": '"blob"',
54-
"FORM_DATA": '"formData"'
55+
"FORM_DATA": isFetchTemplate ? '"formData"' : '"document"'
5556
}
5657

5758
const bodyTmpl = _.get(payload, "name") || null;
@@ -90,5 +91,6 @@ const describeReturnType = () => {
9091
<%~ bodyTmpl ? `body: ${bodyTmpl},` : '' %>
9192
<%~ securityTmpl ? `secure: ${securityTmpl},` : '' %>
9293
<%~ bodyContentKindTmpl ? `type: ${bodyContentKindTmpl},` : '' %>
94+
<%~ responseFormatTmpl ? `format: ${responseFormatTmpl},` : '' %>
9395
...<%~ _.get(requestConfigParam, "name") %>,
9496
})

‎tests/generated/v2.0/adafruit.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
177177
/** query params */
178178
query?: QueryParamsType;
179179
/** format of response (i.e. response.json() -> format: "json") */
180-
format?: keyof Omit<Body, "body" | "bodyUsed">;
180+
format?: ResponseFormat;
181181
/** request body */
182182
body?: unknown;
183183
/** base url */

‎tests/generated/v2.0/another-example.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
153153
/** query params */
154154
query?: QueryParamsType;
155155
/** format of response (i.e. response.json() -> format: "json") */
156-
format?: keyof Omit<Body, "body" | "bodyUsed">;
156+
format?: ResponseFormat;
157157
/** request body */
158158
body?: unknown;
159159
/** base url */

‎tests/generated/v2.0/another-schema.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
4545
/** query params */
4646
query?: QueryParamsType;
4747
/** format of response (i.e. response.json() -> format: "json") */
48-
format?: keyof Omit<Body, "body" | "bodyUsed">;
48+
format?: ResponseFormat;
4949
/** request body */
5050
body?: unknown;
5151
/** base url */

‎tests/generated/v2.0/api-with-examples.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
2222
/** query params */
2323
query?: QueryParamsType;
2424
/** format of response (i.e. response.json() -> format: "json") */
25-
format?: keyof Omit<Body, "body" | "bodyUsed">;
25+
format?: ResponseFormat;
2626
/** request body */
2727
body?: unknown;
2828
/** base url */

‎tests/generated/v2.0/authentiq.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
7474
/** query params */
7575
query?: QueryParamsType;
7676
/** format of response (i.e. response.json() -> format: "json") */
77-
format?: keyof Omit<Body, "body" | "bodyUsed">;
77+
format?: ResponseFormat;
7878
/** request body */
7979
body?: unknown;
8080
/** base url */

‎tests/generated/v2.0/example1.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
4949
/** query params */
5050
query?: QueryParamsType;
5151
/** format of response (i.e. response.json() -> format: "json") */
52-
format?: keyof Omit<Body, "body" | "bodyUsed">;
52+
format?: ResponseFormat;
5353
/** request body */
5454
body?: unknown;
5555
/** base url */

‎tests/generated/v2.0/file-formdata-example.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
2222
/** query params */
2323
query?: QueryParamsType;
2424
/** format of response (i.e. response.json() -> format: "json") */
25-
format?: keyof Omit<Body, "body" | "bodyUsed">;
25+
format?: ResponseFormat;
2626
/** request body */
2727
body?: unknown;
2828
/** base url */

‎tests/generated/v2.0/furkot-example.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
8585
/** query params */
8686
query?: QueryParamsType;
8787
/** format of response (i.e. response.json() -> format: "json") */
88-
format?: keyof Omit<Body, "body" | "bodyUsed">;
88+
format?: ResponseFormat;
8989
/** request body */
9090
body?: unknown;
9191
/** base url */

‎tests/generated/v2.0/giphy.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
304304
/** query params */
305305
query?: QueryParamsType;
306306
/** format of response (i.e. response.json() -> format: "json") */
307-
format?: keyof Omit<Body, "body" | "bodyUsed">;
307+
format?: ResponseFormat;
308308
/** request body */
309309
body?: unknown;
310310
/** base url */

‎tests/generated/v2.0/github-swagger.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1447,7 +1447,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
14471447
/** query params */
14481448
query?: QueryParamsType;
14491449
/** format of response (i.e. response.json() -> format: "json") */
1450-
format?: keyof Omit<Body, "body" | "bodyUsed">;
1450+
format?: ResponseFormat;
14511451
/** request body */
14521452
body?: unknown;
14531453
/** base url */

‎tests/generated/v2.0/path-args.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
2222
/** query params */
2323
query?: QueryParamsType;
2424
/** format of response (i.e. response.json() -> format: "json") */
25-
format?: keyof Omit<Body, "body" | "bodyUsed">;
25+
format?: ResponseFormat;
2626
/** request body */
2727
body?: unknown;
2828
/** base url */

‎tests/generated/v2.0/petstore-expanded.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
5959
/** query params */
6060
query?: QueryParamsType;
6161
/** format of response (i.e. response.json() -> format: "json") */
62-
format?: keyof Omit<Body, "body" | "bodyUsed">;
62+
format?: ResponseFormat;
6363
/** request body */
6464
body?: unknown;
6565
/** base url */

‎tests/generated/v2.0/petstore-minimal.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
3030
/** query params */
3131
query?: QueryParamsType;
3232
/** format of response (i.e. response.json() -> format: "json") */
33-
format?: keyof Omit<Body, "body" | "bodyUsed">;
33+
format?: ResponseFormat;
3434
/** request body */
3535
body?: unknown;
3636
/** base url */

‎tests/generated/v2.0/petstore-simple.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
4545
/** query params */
4646
query?: QueryParamsType;
4747
/** format of response (i.e. response.json() -> format: "json") */
48-
format?: keyof Omit<Body, "body" | "bodyUsed">;
48+
format?: ResponseFormat;
4949
/** request body */
5050
body?: unknown;
5151
/** base url */

‎tests/generated/v2.0/petstore-swagger-io.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
9090
/** query params */
9191
query?: QueryParamsType;
9292
/** format of response (i.e. response.json() -> format: "json") */
93-
format?: keyof Omit<Body, "body" | "bodyUsed">;
93+
format?: ResponseFormat;
9494
/** request body */
9595
body?: unknown;
9696
/** base url */

‎tests/generated/v2.0/petstore-with-external-docs.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
3535
/** query params */
3636
query?: QueryParamsType;
3737
/** format of response (i.e. response.json() -> format: "json") */
38-
format?: keyof Omit<Body, "body" | "bodyUsed">;
38+
format?: ResponseFormat;
3939
/** request body */
4040
body?: unknown;
4141
/** base url */

‎tests/generated/v2.0/petstore.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
3737
/** query params */
3838
query?: QueryParamsType;
3939
/** format of response (i.e. response.json() -> format: "json") */
40-
format?: keyof Omit<Body, "body" | "bodyUsed">;
40+
format?: ResponseFormat;
4141
/** request body */
4242
body?: unknown;
4343
/** base url */

‎tests/generated/v2.0/query-path-param.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
2222
/** query params */
2323
query?: QueryParamsType;
2424
/** format of response (i.e. response.json() -> format: "json") */
25-
format?: keyof Omit<Body, "body" | "bodyUsed">;
25+
format?: ResponseFormat;
2626
/** request body */
2727
body?: unknown;
2828
/** base url */

‎tests/generated/v2.0/uber.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
117117
/** query params */
118118
query?: QueryParamsType;
119119
/** format of response (i.e. response.json() -> format: "json") */
120-
format?: keyof Omit<Body, "body" | "bodyUsed">;
120+
format?: ResponseFormat;
121121
/** request body */
122122
body?: unknown;
123123
/** base url */

‎tests/generated/v3.0/additional-properties.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
2929
/** query params */
3030
query?: QueryParamsType;
3131
/** format of response (i.e. response.json() -> format: "json") */
32-
format?: keyof Omit<Body, "body" | "bodyUsed">;
32+
format?: ResponseFormat;
3333
/** request body */
3434
body?: unknown;
3535
/** base url */

‎tests/generated/v3.0/additional-properties2.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
2626
/** query params */
2727
query?: QueryParamsType;
2828
/** format of response (i.e. response.json() -> format: "json") */
29-
format?: keyof Omit<Body, "body" | "bodyUsed">;
29+
format?: ResponseFormat;
3030
/** request body */
3131
body?: unknown;
3232
/** base url */

‎tests/generated/v3.0/allof-example.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
3030
/** query params */
3131
query?: QueryParamsType;
3232
/** format of response (i.e. response.json() -> format: "json") */
33-
format?: keyof Omit<Body, "body" | "bodyUsed">;
33+
format?: ResponseFormat;
3434
/** request body */
3535
body?: unknown;
3636
/** base url */

‎tests/generated/v3.0/anyof-example.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
3232
/** query params */
3333
query?: QueryParamsType;
3434
/** format of response (i.e. response.json() -> format: "json") */
35-
format?: keyof Omit<Body, "body" | "bodyUsed">;
35+
format?: ResponseFormat;
3636
/** request body */
3737
body?: unknown;
3838
/** base url */

‎tests/generated/v3.0/api-with-examples.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
2222
/** query params */
2323
query?: QueryParamsType;
2424
/** format of response (i.e. response.json() -> format: "json") */
25-
format?: keyof Omit<Body, "body" | "bodyUsed">;
25+
format?: ResponseFormat;
2626
/** request body */
2727
body?: unknown;
2828
/** base url */

‎tests/generated/v3.0/callback-example.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
2222
/** query params */
2323
query?: QueryParamsType;
2424
/** format of response (i.e. response.json() -> format: "json") */
25-
format?: keyof Omit<Body, "body" | "bodyUsed">;
25+
format?: ResponseFormat;
2626
/** request body */
2727
body?: unknown;
2828
/** base url */

‎tests/generated/v3.0/components-responses.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
2222
/** query params */
2323
query?: QueryParamsType;
2424
/** format of response (i.e. response.json() -> format: "json") */
25-
format?: keyof Omit<Body, "body" | "bodyUsed">;
25+
format?: ResponseFormat;
2626
/** request body */
2727
body?: unknown;
2828
/** base url */

‎tests/generated/v3.0/explode-param-3.0.1.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
3838
/** query params */
3939
query?: QueryParamsType;
4040
/** format of response (i.e. response.json() -> format: "json") */
41-
format?: keyof Omit<Body, "body" | "bodyUsed">;
41+
format?: ResponseFormat;
4242
/** request body */
4343
body?: unknown;
4444
/** base url */

‎tests/generated/v3.0/full-swagger-scheme.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -8966,7 +8966,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
89668966
/** query params */
89678967
query?: QueryParamsType;
89688968
/** format of response (i.e. response.json() -> format: "json") */
8969-
format?: keyof Omit<Body, "body" | "bodyUsed">;
8969+
format?: ResponseFormat;
89708970
/** request body */
89718971
body?: unknown;
89728972
/** base url */

‎tests/generated/v3.0/link-example.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ export interface FullRequestParams extends Omit<RequestInit, "body"> {
3939
/** query params */
4040
query?: QueryParamsType;
4141
/** format of response (i.e. response.json() -> format: "json") */
42-
format?: keyof Omit<Body, "body" | "bodyUsed">;
42+
format?: ResponseFormat;
4343
/** request body */
4444
body?: unknown;
4545
/** base url */

0 commit comments

Comments
 (0)