Skip to content

Commit af4dfb7

Browse files
askvortcovaskvortcov
committed
propagate useVersionId to swagger v2 parser
1 parent c812bd0 commit af4dfb7

7 files changed

+72
-48
lines changed

‎src/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ export const generate = async ({
8080

8181
switch (openApiVersion) {
8282
case OpenApiVersion.V2: {
83-
const client = parseV2(openApi);
83+
const client = parseV2(openApi, useOperationId);
8484
const clientFinal = postProcessClient(client);
8585
if (!write) break;
8686
await writeClient(

‎src/openApi/v2/index.ts

+4-3
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,14 @@ import { getServiceVersion } from './parser/getServiceVersion';
88
/**
99
* Parse the OpenAPI specification to a Client model that contains
1010
* all the models, services and schema's we should output.
11-
* @param openApi The OpenAPI spec that we have loaded from disk.
11+
* @param openApi The OpenAPI spec that we have loaded from disk.
12+
* @param useOperationId should the operationId be used when generating operation names
1213
*/
13-
export const parse = (openApi: OpenApi): Client => {
14+
export const parse = (openApi: OpenApi, useOperationId: boolean): Client => {
1415
const version = getServiceVersion(openApi.info.version);
1516
const server = getServer(openApi);
1617
const models = getModels(openApi);
17-
const services = getServices(openApi);
18+
const services = getServices(openApi, useOperationId);
1819

1920
return { version, server, models, services };
2021
};

‎src/openApi/v2/parser/getOperation.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,11 @@ export const getOperation = (
1717
method: string,
1818
tag: string,
1919
op: OpenApiOperation,
20-
pathParams: OperationParameters
20+
pathParams: OperationParameters,
21+
useOperationId: boolean
2122
): Operation => {
2223
const serviceName = getServiceName(tag);
23-
const operationName = getOperationName(url, method, op.operationId);
24+
const operationName = getOperationName(url, method, useOperationId, op.operationId);
2425

2526
// Create a new operation object for this method.
2627
const operation: Operation = {

‎src/openApi/v2/parser/getOperationName.spec.ts

+26-20
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,32 @@ import { getOperationName } from './getOperationName';
22

33
describe('getOperationName', () => {
44
it('should produce correct result', () => {
5-
expect(getOperationName('/api/v{api-version}/users', 'GET', 'GetAllUsers')).toEqual('getAllUsers');
6-
expect(getOperationName('/api/v{api-version}/users', 'GET', undefined)).toEqual('getApiUsers');
7-
expect(getOperationName('/api/v{api-version}/users', 'POST', undefined)).toEqual('postApiUsers');
8-
expect(getOperationName('/api/v1/users', 'GET', 'GetAllUsers')).toEqual('getAllUsers');
9-
expect(getOperationName('/api/v1/users', 'GET', undefined)).toEqual('getApiV1Users');
10-
expect(getOperationName('/api/v1/users', 'POST', undefined)).toEqual('postApiV1Users');
11-
expect(getOperationName('/api/v1/users/{id}', 'GET', undefined)).toEqual('getApiV1Users');
12-
expect(getOperationName('/api/v1/users/{id}', 'POST', undefined)).toEqual('postApiV1Users');
5+
expect(getOperationName('/api/v{api-version}/users', 'GET', true, 'GetAllUsers')).toEqual('getAllUsers');
6+
expect(getOperationName('/api/v{api-version}/users', 'GET', true, undefined)).toEqual('getApiUsers');
7+
expect(getOperationName('/api/v{api-version}/users', 'POST', true, undefined)).toEqual('postApiUsers');
8+
expect(getOperationName('/api/v1/users', 'GET', true, 'GetAllUsers')).toEqual('getAllUsers');
9+
expect(getOperationName('/api/v1/users', 'GET', true, undefined)).toEqual('getApiV1Users');
10+
expect(getOperationName('/api/v1/users', 'POST', true, undefined)).toEqual('postApiV1Users');
11+
expect(getOperationName('/api/v1/users/{id}', 'GET', true, undefined)).toEqual('getApiV1UsersById');
12+
expect(getOperationName('/api/v1/users/{id}', 'POST', true, undefined)).toEqual('postApiV1UsersById');
1313

14-
expect(getOperationName('/api/v{api-version}/users', 'GET', 'fooBar')).toEqual('fooBar');
15-
expect(getOperationName('/api/v{api-version}/users', 'GET', 'FooBar')).toEqual('fooBar');
16-
expect(getOperationName('/api/v{api-version}/users', 'GET', 'Foo Bar')).toEqual('fooBar');
17-
expect(getOperationName('/api/v{api-version}/users', 'GET', 'foo bar')).toEqual('fooBar');
18-
expect(getOperationName('/api/v{api-version}/users', 'GET', 'foo-bar')).toEqual('fooBar');
19-
expect(getOperationName('/api/v{api-version}/users', 'GET', 'foo_bar')).toEqual('fooBar');
20-
expect(getOperationName('/api/v{api-version}/users', 'GET', 'foo.bar')).toEqual('fooBar');
21-
expect(getOperationName('/api/v{api-version}/users', 'GET', '@foo.bar')).toEqual('fooBar');
22-
expect(getOperationName('/api/v{api-version}/users', 'GET', '$foo.bar')).toEqual('fooBar');
23-
expect(getOperationName('/api/v{api-version}/users', 'GET', '_foo.bar')).toEqual('fooBar');
24-
expect(getOperationName('/api/v{api-version}/users', 'GET', '-foo.bar')).toEqual('fooBar');
25-
expect(getOperationName('/api/v{api-version}/users', 'GET', '123.foo.bar')).toEqual('fooBar');
14+
expect(getOperationName('/api/v{api-version}/users', 'GET', true, 'fooBar')).toEqual('fooBar');
15+
expect(getOperationName('/api/v{api-version}/users', 'GET', true, 'FooBar')).toEqual('fooBar');
16+
expect(getOperationName('/api/v{api-version}/users', 'GET', true, 'Foo Bar')).toEqual('fooBar');
17+
expect(getOperationName('/api/v{api-version}/users', 'GET', true, 'foo bar')).toEqual('fooBar');
18+
expect(getOperationName('/api/v{api-version}/users', 'GET', true, 'foo-bar')).toEqual('fooBar');
19+
expect(getOperationName('/api/v{api-version}/users', 'GET', true, 'foo_bar')).toEqual('fooBar');
20+
expect(getOperationName('/api/v{api-version}/users', 'GET', true, 'foo.bar')).toEqual('fooBar');
21+
expect(getOperationName('/api/v{api-version}/users', 'GET', true, '@foo.bar')).toEqual('fooBar');
22+
expect(getOperationName('/api/v{api-version}/users', 'GET', true, '$foo.bar')).toEqual('fooBar');
23+
expect(getOperationName('/api/v{api-version}/users', 'GET', true, '_foo.bar')).toEqual('fooBar');
24+
expect(getOperationName('/api/v{api-version}/users', 'GET', true, '-foo.bar')).toEqual('fooBar');
25+
expect(getOperationName('/api/v{api-version}/users', 'GET', true, '123.foo.bar')).toEqual('fooBar');
26+
27+
expect(getOperationName('/api/v1/users', 'GET', false, 'GetAllUsers')).toEqual('getApiV1Users');
28+
expect(getOperationName('/api/v{api-version}/users', 'GET', false, 'fooBar')).toEqual('getApiUsers');
29+
expect(
30+
getOperationName('/api/v{api-version}/users/{userId}/location/{locationId}', 'GET', false, 'fooBar')
31+
).toEqual('getApiUsersByUserIdLocationByLocationId');
2632
});
2733
});

‎src/openApi/v2/parser/getOperationName.ts

+8-3
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,13 @@ import camelCase from 'camelcase';
55
* This will use the operation ID - if available - and otherwise fallback
66
* on a generated name from the URL
77
*/
8-
export const getOperationName = (url: string, method: string, operationId?: string): string => {
9-
if (operationId) {
8+
export const getOperationName = (
9+
url: string,
10+
method: string,
11+
useOperationId: boolean,
12+
operationId?: string
13+
): string => {
14+
if (useOperationId && operationId) {
1015
return camelCase(
1116
operationId
1217
.replace(/^[^a-zA-Z]+/g, '')
@@ -17,7 +22,7 @@ export const getOperationName = (url: string, method: string, operationId?: stri
1722

1823
const urlWithoutPlaceholders = url
1924
.replace(/[^/]*?{api-version}.*?\//g, '')
20-
.replace(/{(.*?)}/g, '')
25+
.replace(/{(.*?)}/g, 'by-$1')
2126
.replace(/\//g, '-');
2227

2328
return camelCase(`${method}-${urlWithoutPlaceholders}`);

‎src/openApi/v2/parser/getServices.spec.ts

+20-17
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,31 @@ import { getServices } from './getServices';
22

33
describe('getServices', () => {
44
it('should create a unnamed service if tags are empty', () => {
5-
const services = getServices({
6-
swagger: '2.0',
7-
info: {
8-
title: 'x',
9-
version: '1',
10-
},
11-
paths: {
12-
'/api/trips': {
13-
get: {
14-
tags: [],
15-
responses: {
16-
200: {
17-
description: 'x',
18-
},
19-
default: {
20-
description: 'default',
5+
const services = getServices(
6+
{
7+
swagger: '2.0',
8+
info: {
9+
title: 'x',
10+
version: '1',
11+
},
12+
paths: {
13+
'/api/trips': {
14+
get: {
15+
tags: [],
16+
responses: {
17+
200: {
18+
description: 'x',
19+
},
20+
default: {
21+
description: 'default',
22+
},
2123
},
2224
},
2325
},
2426
},
2527
},
26-
});
28+
false
29+
);
2730

2831
expect(services).toHaveLength(1);
2932
expect(services[0].name).toEqual('Default');

‎src/openApi/v2/parser/getServices.ts

+10-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { getOperationParameters } from './getOperationParameters';
77
/**
88
* Get the OpenAPI services
99
*/
10-
export const getServices = (openApi: OpenApi): Service[] => {
10+
export const getServices = (openApi: OpenApi, useOperationId: boolean): Service[] => {
1111
const services = new Map<string, Service>();
1212
for (const url in openApi.paths) {
1313
if (openApi.paths.hasOwnProperty(url)) {
@@ -30,7 +30,15 @@ export const getServices = (openApi: OpenApi): Service[] => {
3030
const op = path[method]!;
3131
const tags = op.tags?.length ? op.tags.filter(unique) : ['Default'];
3232
tags.forEach(tag => {
33-
const operation = getOperation(openApi, url, method, tag, op, pathParams);
33+
const operation = getOperation(
34+
openApi,
35+
url,
36+
method,
37+
tag,
38+
op,
39+
pathParams,
40+
useOperationId
41+
);
3442

3543
// If we have already declared a service, then we should fetch that and
3644
// append the new method to it. Otherwise we should create a new service object.

0 commit comments

Comments
 (0)