archive-gh-me/openapi-typescript-codegen
1
0
Fork 0
mirror of https://github.com/ferdikoomen/openapi-typescript-codegen.git synced 2025-12-08 20:16:21 +00:00
Code Issues Projects Releases Wiki Activity

- Added WIP Angular client

Browse Source
This commit is contained in:
Ferdi Koomen 2022-01-25 20:02:53 +01:00
parent 9424a7b240
commit 1d8dc54d94
20 changed files with 83 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/index.ts
View File

@ -4,6 +4,7 @@ import { parse as parseV2 } from './openApi/v2';
import { parse as parseV3 } from './openApi/v3';
import { getOpenApiSpec } from './utils/getOpenApiSpec';
import { getOpenApiVersion, OpenApiVersion } from './utils/getOpenApiVersion';
import { isDefined } from './utils/isDefined';
import { isString } from './utils/isString';
import { postProcessClient } from './utils/postProcessClient';
import { registerHandlebarTemplates } from './utils/registerHandlebarTemplates';
@ -64,6 +65,10 @@ export const generate = async ({
request,
write = true,
}: Options): Promise<void> => {
if (httpClient === HttpClient.ANGULAR && isDefined(clientName)) {
throw new Error('Angular client does not support --name property');
}
const openApi = isString(input) ? await getOpenApiSpec(input) : input;
const openApiVersion = getOpenApiVersion(openApi);
const templates = registerHandlebarTemplates({

4
src/templates/core/angular/getHeaders.hbs
View File

@ -1,4 +1,4 @@
const getHeaders = async (config: OpenAPIConfig, options: ApiRequestOptions): Promise<Headers> => {
const getHeaders = async (config: OpenAPIConfig, options: ApiRequestOptions): Promise<HttpHeaders> => {
const token = await resolve(options, config.TOKEN);
const username = await resolve(options, config.USERNAME);
const password = await resolve(options, config.PASSWORD);
@ -15,7 +15,7 @@ const getHeaders = async (config: OpenAPIConfig, options: ApiRequestOptions): Pr
[key]: String(value),
}), {} as Record<string, string>);
const headers = new Headers(defaultHeaders);
const headers = new HttpHeaders(defaultHeaders);
if (isStringWithValue(token)) {
headers.append('Authorization', `Bearer ${token}`);

2
src/templates/core/angular/getRequestBody.hbs
View File

@ -1,4 +1,4 @@
const getRequestBody = (options: ApiRequestOptions): BodyInit | undefined => {
const getRequestBody = (options: ApiRequestOptions): any => {
if (options.body) {
if (options.mediaType?.includes('/json')) {
return JSON.stringify(options.body)

18
src/templates/core/angular/getResponseBody.hbs
View File

@ -1,18 +1,6 @@
const getResponseBody = async (response: Response): Promise<any> => {
if (response.status !== 204) {
try {
const contentType = response.headers.get('Content-Type');
if (contentType) {
const isJSON = contentType.toLowerCase().startsWith('application/json');
if (isJSON) {
return await response.json();
} else {
return await response.text();
}
}
} catch (error) {
console.error(error);
}
const getResponseBody = <T>(response: HttpResponse<T>): T | undefined => {
if (response.status !== 204 && response.body !== null) {
return response.body;
}
return;
};

8
src/templates/core/angular/getResponseHeader.hbs
View File

@ -1,8 +1,8 @@
const getResponseHeader = (response: Response, responseHeader?: string): string | undefined => {
const getResponseHeader = <T>(response: HttpResponse<T>, responseHeader?: string): string | undefined => {
if (responseHeader) {
const content = response.headers.get(responseHeader);
if (isString(content)) {
return content;
const value = response.headers.get(responseHeader);
if (isString(value)) {
return value;
}
}
return;

43
src/templates/core/angular/request.hbs
View File

@ -1,13 +1,11 @@
{{>header}}
import { HttpClient, HttpHeaders } from '@angular/common/http';
import { HttpClient, HttpHeaders, HttpResponse } from '@angular/common/http';
import { Observable } from 'rxjs';
import { ApiError } from './ApiError';
import type { ApiRequestOptions } from './ApiRequestOptions';
import type { ApiResult } from './ApiResult';
import { CancelablePromise } from './CancelablePromise';
import type { OnCancel } from './CancelablePromise';
import type { OpenAPIConfig } from './OpenAPI';
{{>functions/isDefined}}
@ -61,37 +59,40 @@ import type { OpenAPIConfig } from './OpenAPI';
/**
* Request method
* @param config The OpenAPI configuration object
* @param http The Angular HTTP client
* @param options The request options from the service
* @returns CancelablePromise<T>
* @throws ApiError
*/
export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): CancelablePromise<T> => {
return new CancelablePromise(async (resolve, reject, onCancel) => {
export const request = <T>(config: OpenAPIConfig, http: HttpClient, options: ApiRequestOptions): Observable<T> => {
return new Observable<T>(subscriber => {
try {
const url = getUrl(config, options);
const formData = getFormData(options);
const body = getRequestBody(options);
const headers = await getHeaders(config, options);
getHeaders(config, options).then(headers => {
if (!onCancel.isCancelled) {
const response = await sendRequest(config, options, url, formData, body, headers, onCancel);
const responseBody = await getResponseBody(response);
const responseHeader = getResponseHeader(response, options.responseHeader);
sendRequest<T>(config, options, http, url, formData, body, headers)
.subscribe(response => {
const responseBody = getResponseBody(response);
const responseHeader = getResponseHeader(response, options.responseHeader);
const result: ApiResult = {
url,
ok: response.ok,
status: response.status,
statusText: response.statusText,
body: responseHeader ?? responseBody,
};
const result: ApiResult = {
url,
ok: response.ok,
status: response.status,
statusText: response.statusText,
body: responseHeader ?? responseBody,
};
catchErrors(options, result);
catchErrors(options, result);
resolve(result.body);
}
subscriber.next(result.body);
});
});
} catch (error) {
reject(error);
subscriber.error(error);
}
});
};

30
src/templates/core/angular/sendRequest.hbs
View File

@ -1,26 +1,16 @@
export const sendRequest = async (
export const sendRequest = <T>(
config: OpenAPIConfig,
options: ApiRequestOptions,
http: HttpClient,
url: string,
body: any,
formData: FormData | undefined,
body: BodyInit | undefined,
headers: Headers,
onCancel: OnCancel
): Promise<Response> => {
const controller = new AbortController();
const request: RequestInit = {
headers: HttpHeaders
): Observable<HttpResponse<T>> => {
return http.request<T>(url, options.method, {
headers,
body: body || formData,
method: options.method,
signal: controller.signal,
};
if (config.WITH_CREDENTIALS) {
request.credentials = config.CREDENTIALS;
}
onCancel(() => controller.abort());
return await fetch(url, request);
body: body ?? formData,
withCredentials: config.WITH_CREDENTIALS,
observe: 'response',
});
};

2
src/templates/core/axios/request.hbs
View File

@ -74,7 +74,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): C
const headers = await getHeaders(config, options, formData);
if (!onCancel.isCancelled) {
const response = await sendRequest(config, options, url, formData, body, headers, onCancel);
const response = await sendRequest<T>(config, options, url, body, formData, headers, onCancel);
const responseBody = getResponseBody(response);
const responseHeader = getResponseHeader(response, options.responseHeader);

6
src/templates/core/axios/sendRequest.hbs
View File

@ -1,12 +1,12 @@
const sendRequest = async (
const sendRequest = async <T>(
config: OpenAPIConfig,
options: ApiRequestOptions,
url: string,
formData: FormData | undefined,
body: any,
formData: FormData | undefined,
headers: Record<string, string>,
onCancel: OnCancel
): Promise<AxiosResponse<any>> => {
): Promise<AxiosResponse<T>> => {
const source = axios.CancelToken.source();
const requestConfig: AxiosRequestConfig = {

2
src/templates/core/fetch/getRequestBody.hbs
View File

@ -1,4 +1,4 @@
const getRequestBody = (options: ApiRequestOptions): BodyInit | undefined => {
const getRequestBody = (options: ApiRequestOptions): any => {
if (options.body) {
if (options.mediaType?.includes('/json')) {
return JSON.stringify(options.body)

2
src/templates/core/fetch/request.hbs
View File

@ -71,7 +71,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): C
const headers = await getHeaders(config, options);
if (!onCancel.isCancelled) {
const response = await sendRequest(config, options, url, formData, body, headers, onCancel);
const response = await sendRequest(config, options, url, body, formData, headers, onCancel);
const responseBody = await getResponseBody(response);
const responseHeader = getResponseHeader(response, options.responseHeader);

2
src/templates/core/fetch/sendRequest.hbs
View File

@ -2,8 +2,8 @@ export const sendRequest = async (
config: OpenAPIConfig,
options: ApiRequestOptions,
url: string,
body: any,
formData: FormData | undefined,
body: BodyInit | undefined,
headers: Headers,
onCancel: OnCancel
): Promise<Response> => {

2
src/templates/core/node/getRequestBody.hbs
View File

@ -1,4 +1,4 @@
const getRequestBody = (options: ApiRequestOptions): BodyInit | undefined => {
const getRequestBody = (options: ApiRequestOptions): any => {
if (options.body) {
if (options.mediaType?.includes('/json')) {
return JSON.stringify(options.body)

2
src/templates/core/node/request.hbs
View File

@ -75,7 +75,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): C
const headers = await getHeaders(config, options);
if (!onCancel.isCancelled) {
const response = await sendRequest(options, url, formData, body, headers, onCancel);
const response = await sendRequest(options, url, body, formData, headers, onCancel);
const responseBody = await getResponseBody(response);
const responseHeader = getResponseHeader(response, options.responseHeader);

2
src/templates/core/node/sendRequest.hbs
View File

@ -1,8 +1,8 @@
export const sendRequest = async (
options: ApiRequestOptions,
url: string,
body: any,
formData: FormData | undefined,
body: BodyInit | undefined,
headers: Headers,
onCancel: OnCancel
): Promise<Response> => {

2
src/templates/core/xhr/request.hbs
View File

@ -74,7 +74,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): C
const headers = await getHeaders(config, options);
if (!onCancel.isCancelled) {
const response = await sendRequest(config, options, url, formData, body, headers, onCancel);
const response = await sendRequest(config, options, url, body, formData, headers, onCancel);
const responseBody = getResponseBody(response);
const responseHeader = getResponseHeader(response, options.responseHeader);

2
src/templates/core/xhr/sendRequest.hbs
View File

@ -2,8 +2,8 @@ export const sendRequest = async (
config: OpenAPIConfig,
options: ApiRequestOptions,
url: string,
formData: FormData | undefined,
body: any,
formData: FormData | undefined,
headers: Headers,
onCancel: OnCancel
): Promise<XMLHttpRequest> => {

3
src/templates/exportService.hbs
View File

@ -72,10 +72,11 @@ export class {{{name}}}{{{@root.postfix}}} {
{{else}}
{{#equals @root.httpClient 'angular'}}
public {{{name}}}({{>parameters}}): Observable<{{>result}}> {
return __request(OpenAPI, this.http, {
{{else}}
public static {{{name}}}({{>parameters}}): CancelablePromise<{{>result}}> {
{{/equals}}
return __request(OpenAPI, {
{{/equals}}
{{/if}}
method: '{{{method}}}',
url: '{{{path}}}',

12
src/utils/registerHandlebarTemplates.ts
View File

@ -2,6 +2,12 @@ import Handlebars from 'handlebars/runtime';
import { HttpClient } from '../HttpClient';
import templateClient from '../templates/client.hbs';
import angularGetHeaders from '../templates/core/angular/getHeaders.hbs';
import angularGetRequestBody from '../templates/core/angular/getRequestBody.hbs';
import angularGetResponseBody from '../templates/core/angular/getResponseBody.hbs';
import angularGetResponseHeader from '../templates/core/angular/getResponseHeader.hbs';
import angularRequest from '../templates/core/angular/request.hbs';
import angularSendRequest from '../templates/core/angular/sendRequest.hbs';
import templateCoreApiError from '../templates/core/ApiError.hbs';
import templateCoreApiRequestOptions from '../templates/core/ApiRequestOptions.hbs';
import templateCoreApiResult from '../templates/core/ApiResult.hbs';
@ -19,12 +25,6 @@ import fetchGetResponseBody from '../templates/core/fetch/getResponseBody.hbs';
import fetchGetResponseHeader from '../templates/core/fetch/getResponseHeader.hbs';
import fetchRequest from '../templates/core/fetch/request.hbs';
import fetchSendRequest from '../templates/core/fetch/sendRequest.hbs';
import angularGetHeaders from '../templates/core/angular/getHeaders.hbs';
import angularGetRequestBody from '../templates/core/angular/getRequestBody.hbs';
import angularGetResponseBody from '../templates/core/angular/getResponseBody.hbs';
import angularGetResponseHeader from '../templates/core/angular/getResponseHeader.hbs';
import angularRequest from '../templates/core/angular/request.hbs';
import angularSendRequest from '../templates/core/angular/sendRequest.hbs';
import functionBase64 from '../templates/core/functions/base64.hbs';
import functionCatchErrors from '../templates/core/functions/catchErrors.hbs';
import functionGetFormData from '../templates/core/functions/getFormData.hbs';

22
test/__snapshots__/index.spec.ts.snap
View File

@ -399,7 +399,7 @@ const getHeaders = async (config: OpenAPIConfig, options: ApiRequestOptions): Pr
return headers;
};
const getRequestBody = (options: ApiRequestOptions): BodyInit | undefined => {
const getRequestBody = (options: ApiRequestOptions): any => {
if (options.body) {
if (options.mediaType?.includes('/json')) {
return JSON.stringify(options.body)
@ -416,8 +416,8 @@ export const sendRequest = async (
config: OpenAPIConfig,
options: ApiRequestOptions,
url: string,
body: any,
formData: FormData | undefined,
body: BodyInit | undefined,
headers: Headers,
onCancel: OnCancel
): Promise<Response> => {
@ -506,7 +506,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): C
const headers = await getHeaders(config, options);
if (!onCancel.isCancelled) {
const response = await sendRequest(config, options, url, formData, body, headers, onCancel);
const response = await sendRequest(config, options, url, body, formData, headers, onCancel);
const responseBody = await getResponseBody(response);
const responseHeader = getResponseHeader(response, options.responseHeader);
@ -2193,6 +2193,7 @@ exports[`v2 should generate: ./test/generated/v2/services/ComplexService.ts 1`]
/* tslint:disable */
/* eslint-disable */
import type { ModelWithString } from '../models/ModelWithString';
import type { CancelablePromise } from '../core/CancelablePromise';
import { OpenAPI } from '../core/OpenAPI';
import { request as __request } from '../core/request';
@ -2260,6 +2261,7 @@ exports[`v2 should generate: ./test/generated/v2/services/DefaultsService.ts 1`]
/* tslint:disable */
/* eslint-disable */
import type { ModelWithString } from '../models/ModelWithString';
import type { CancelablePromise } from '../core/CancelablePromise';
import { OpenAPI } from '../core/OpenAPI';
import { request as __request } from '../core/request';
@ -2699,6 +2701,7 @@ exports[`v2 should generate: ./test/generated/v2/services/ResponseService.ts 1`]
import type { ModelThatExtends } from '../models/ModelThatExtends';
import type { ModelThatExtendsExtends } from '../models/ModelThatExtendsExtends';
import type { ModelWithString } from '../models/ModelWithString';
import type { CancelablePromise } from '../core/CancelablePromise';
import { OpenAPI } from '../core/OpenAPI';
import { request as __request } from '../core/request';
@ -3296,7 +3299,7 @@ const getHeaders = async (config: OpenAPIConfig, options: ApiRequestOptions): Pr
return headers;
};
const getRequestBody = (options: ApiRequestOptions): BodyInit | undefined => {
const getRequestBody = (options: ApiRequestOptions): any => {
if (options.body) {
if (options.mediaType?.includes('/json')) {
return JSON.stringify(options.body)
@ -3313,8 +3316,8 @@ export const sendRequest = async (
config: OpenAPIConfig,
options: ApiRequestOptions,
url: string,
body: any,
formData: FormData | undefined,
body: BodyInit | undefined,
headers: Headers,
onCancel: OnCancel
): Promise<Response> => {
@ -3403,7 +3406,7 @@ export const request = <T>(config: OpenAPIConfig, options: ApiRequestOptions): C
const headers = await getHeaders(config, options);
if (!onCancel.isCancelled) {
const response = await sendRequest(config, options, url, formData, body, headers, onCancel);
const response = await sendRequest(config, options, url, body, formData, headers, onCancel);
const responseBody = await getResponseBody(response);
const responseHeader = getResponseHeader(response, options.responseHeader);
@ -5670,6 +5673,7 @@ import type { ModelWithArray } from '../models/ModelWithArray';
import type { ModelWithDictionary } from '../models/ModelWithDictionary';
import type { ModelWithEnum } from '../models/ModelWithEnum';
import type { ModelWithString } from '../models/ModelWithString';
import type { CancelablePromise } from '../core/CancelablePromise';
import { OpenAPI } from '../core/OpenAPI';
import { request as __request } from '../core/request';
@ -5770,6 +5774,7 @@ exports[`v3 should generate: ./test/generated/v3/services/DefaultsService.ts 1`]
/* tslint:disable */
/* eslint-disable */
import type { ModelWithString } from '../models/ModelWithString';
import type { CancelablePromise } from '../core/CancelablePromise';
import { OpenAPI } from '../core/OpenAPI';
import { request as __request } from '../core/request';
@ -5970,6 +5975,7 @@ exports[`v3 should generate: ./test/generated/v3/services/FormDataService.ts 1`]
/* tslint:disable */
/* eslint-disable */
import type { ModelWithString } from '../models/ModelWithString';
import type { CancelablePromise } from '../core/CancelablePromise';
import { OpenAPI } from '../core/OpenAPI';
import { request as __request } from '../core/request';
@ -6033,6 +6039,7 @@ exports[`v3 should generate: ./test/generated/v3/services/MultipartService.ts 1`
/* tslint:disable */
/* eslint-disable */
import type { ModelWithString } from '../models/ModelWithString';
import type { CancelablePromise } from '../core/CancelablePromise';
import { OpenAPI } from '../core/OpenAPI';
import { request as __request } from '../core/request';
@ -6200,6 +6207,7 @@ exports[`v3 should generate: ./test/generated/v3/services/ParametersService.ts 1
/* tslint:disable */
/* eslint-disable */
import type { ModelWithString } from '../models/ModelWithString';
import type { CancelablePromise } from '../core/CancelablePromise';
import { OpenAPI } from '../core/OpenAPI';
import { request as __request } from '../core/request';
@ -6343,6 +6351,7 @@ exports[`v3 should generate: ./test/generated/v3/services/RequestBodyService.ts
/* tslint:disable */
/* eslint-disable */
import type { ModelWithString } from '../models/ModelWithString';
import type { CancelablePromise } from '../core/CancelablePromise';
import { OpenAPI } from '../core/OpenAPI';
import { request as __request } from '../core/request';
@ -6379,6 +6388,7 @@ exports[`v3 should generate: ./test/generated/v3/services/ResponseService.ts 1`]
import type { ModelThatExtends } from '../models/ModelThatExtends';
import type { ModelThatExtendsExtends } from '../models/ModelThatExtendsExtends';
import type { ModelWithString } from '../models/ModelWithString';
import type { CancelablePromise } from '../core/CancelablePromise';
import { OpenAPI } from '../core/OpenAPI';
import { request as __request } from '../core/request';