Skip to content

Commit 8cd10e9

Browse files
askvortcovaskvortcov
committed
allow operationId be ignored when generating operation names
1 parent 42a51ec commit 8cd10e9

File tree

8 files changed

+78
-48
lines changed

8 files changed

+78
-48
lines changed

‎bin/index.js

+2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ const params = program
1919
.option('--exportCore <value>', 'Write core files to disk', true)
2020
.option('--exportServices <value>', 'Write services to disk', true)
2121
.option('--exportModels <value>', 'Write models to disk', true)
22+
.option('--ignoreOperationId <value>', 'Use operation id', true)
2223
.option('--exportSchemas <value>', 'Write schemas to disk', false)
2324
.option('--indent <value>', 'Indentation options [4, 2, tabs]', '4')
2425
.option('--postfixServices <value>', 'Service name postfix', 'Service')
@@ -41,6 +42,7 @@ if (OpenAPI) {
4142
exportServices: JSON.parse(params.exportServices) === true,
4243
exportModels: JSON.parse(params.exportModels) === true,
4344
exportSchemas: JSON.parse(params.exportSchemas) === true,
45+
ignoreOperationId: JSON.parse(params.ignoreOperationId) === true,
4446
indent: params.indent,
4547
postfixServices: params.postfixServices,
4648
postfixModels: params.postfixModels,

‎src/index.ts

+4-1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ export type Options = {
2323
exportServices?: boolean;
2424
exportModels?: boolean;
2525
exportSchemas?: boolean;
26+
ignoreOperationId?: boolean;
2627
indent?: Indent;
2728
postfixServices?: string;
2829
postfixModels?: string;
@@ -44,6 +45,7 @@ export type Options = {
4445
* @param exportServices Generate services
4546
* @param exportModels Generate models
4647
* @param exportSchemas Generate schemas
48+
* @param ignoreOperationId Ignore operationId
4749
* @param indent Indentation options (4, 2 or tab)
4850
* @param postfixServices Service name postfix
4951
* @param postfixModels Model name postfix
@@ -61,6 +63,7 @@ export const generate = async ({
6163
exportServices = true,
6264
exportModels = true,
6365
exportSchemas = false,
66+
ignoreOperationId = false,
6467
indent = Indent.SPACE_4,
6568
postfixServices = 'Service',
6669
postfixModels = '',
@@ -101,7 +104,7 @@ export const generate = async ({
101104
}
102105

103106
case OpenApiVersion.V3: {
104-
const client = parseV3(openApi);
107+
const client = parseV3(openApi, ignoreOperationId);
105108
const clientFinal = postProcessClient(client);
106109
if (!write) break;
107110
await writeClient(

‎src/openApi/v3/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 ignoreOperationId should the operationId be ignored when generating operation names
1213
*/
13-
export const parse = (openApi: OpenApi): Client => {
14+
export const parse = (openApi: OpenApi, ignoreOperationId: 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, ignoreOperationId);
1819

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

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

+3-2
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,11 @@ export const getOperation = (
2020
method: string,
2121
tag: string,
2222
op: OpenApiOperation,
23-
pathParams: OperationParameters
23+
pathParams: OperationParameters,
24+
ignoreOperationId: boolean
2425
): Operation => {
2526
const serviceName = getServiceName(tag);
26-
const operationName = getOperationName(url, method, op.operationId);
27+
const operationName = getOperationName(url, method, ignoreOperationId, op.operationId);
2728

2829
// Create a new operation object for this method.
2930
const operation: Operation = {

‎src/openApi/v3/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', false, 'GetAllUsers')).toEqual('getAllUsers');
6+
expect(getOperationName('/api/v{api-version}/users', 'GET', false, undefined)).toEqual('getApiUsers');
7+
expect(getOperationName('/api/v{api-version}/users', 'POST', false, undefined)).toEqual('postApiUsers');
8+
expect(getOperationName('/api/v1/users', 'GET', false, 'GetAllUsers')).toEqual('getAllUsers');
9+
expect(getOperationName('/api/v1/users', 'GET', false, undefined)).toEqual('getApiV1Users');
10+
expect(getOperationName('/api/v1/users', 'POST', false, undefined)).toEqual('postApiV1Users');
11+
expect(getOperationName('/api/v1/users/{id}', 'GET', false, undefined)).toEqual('getApiV1UsersById');
12+
expect(getOperationName('/api/v1/users/{id}', 'POST', false, 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', false, 'fooBar')).toEqual('fooBar');
15+
expect(getOperationName('/api/v{api-version}/users', 'GET', false, 'FooBar')).toEqual('fooBar');
16+
expect(getOperationName('/api/v{api-version}/users', 'GET', false, 'Foo Bar')).toEqual('fooBar');
17+
expect(getOperationName('/api/v{api-version}/users', 'GET', false, 'foo bar')).toEqual('fooBar');
18+
expect(getOperationName('/api/v{api-version}/users', 'GET', false, 'foo-bar')).toEqual('fooBar');
19+
expect(getOperationName('/api/v{api-version}/users', 'GET', false, 'foo_bar')).toEqual('fooBar');
20+
expect(getOperationName('/api/v{api-version}/users', 'GET', false, 'foo.bar')).toEqual('fooBar');
21+
expect(getOperationName('/api/v{api-version}/users', 'GET', false, '@foo.bar')).toEqual('fooBar');
22+
expect(getOperationName('/api/v{api-version}/users', 'GET', false, '$foo.bar')).toEqual('fooBar');
23+
expect(getOperationName('/api/v{api-version}/users', 'GET', false, '_foo.bar')).toEqual('fooBar');
24+
expect(getOperationName('/api/v{api-version}/users', 'GET', false, '-foo.bar')).toEqual('fooBar');
25+
expect(getOperationName('/api/v{api-version}/users', 'GET', false, '123.foo.bar')).toEqual('fooBar');
26+
27+
expect(getOperationName('/api/v1/users', 'GET', true, 'GetAllUsers')).toEqual('getApiV1Users');
28+
expect(getOperationName('/api/v{api-version}/users', 'GET', true, 'fooBar')).toEqual('getApiUsers');
29+
expect(
30+
getOperationName('/api/v{api-version}/users/{userId}/location/{locationId}', 'GET', true, 'fooBar')
31+
).toEqual('getApiUsersByUserIdLocationByLocationId');
2632
});
2733
});

‎src/openApi/v3/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+
ignoreOperationId: boolean,
12+
operationId?: string
13+
): string => {
14+
if (operationId && !ignoreOperationId) {
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/v3/parser/getServices.spec.ts

+21-17
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,33 @@
1+
/* eslint-disable */
12
import { getServices } from './getServices';
23

34
describe('getServices', () => {
45
it('should create a unnamed service if tags are empty', () => {
5-
const services = getServices({
6-
openapi: '3.0.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',
6+
const services = getServices(
7+
{
8+
openapi: '3.0.0',
9+
info: {
10+
title: 'x',
11+
version: '1',
12+
},
13+
paths: {
14+
'/api/trips': {
15+
get: {
16+
tags: [],
17+
responses: {
18+
200: {
19+
description: 'x',
20+
},
21+
default: {
22+
description: 'default',
23+
},
2124
},
2225
},
2326
},
2427
},
2528
},
26-
});
29+
false,
30+
);
2731

2832
expect(services).toHaveLength(1);
2933
expect(services[0].name).toEqual('Default');

‎src/openApi/v3/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, ignoreOperationId: 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+
ignoreOperationId
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)