Skip to content

feat(rest): add openapi schema consolidation #4365

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dougal83 merged 1 commit into from
Apr 19, 2020
Merged

feat(rest): add openapi schema consolidation #4365

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/openapi-v3/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions packages/openapi-v3/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
"@loopback/testlab": "^3.0.1",
"@types/debug": "^4.1.5",
"@types/http-status": "^1.1.2",
"@types/json-merge-patch": "0.0.4",
"@types/lodash": "^4.14.150",
"@types/node": "^10.17.20"
},
Expand Down
6 changes: 4 additions & 2 deletions packages/openapi-v3/src/enhancers/spec-enhancer.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,12 @@ export class OASEnhancerService {
* Find an enhancer by its name
* @param name The name of the enhancer you want to find
*/
async getEnhancerByName(name: string): Promise<OASEnhancer | undefined> {
async getEnhancerByName<T extends OASEnhancer = OASEnhancer>(
name: string,
): Promise<T | undefined> {
// Get the latest list of enhancers
const enhancers = await this.getEnhancers();
return enhancers.find(e => e.name === name);
return enhancers.find(e => e.name === name) as T | undefined;
}

/**
Expand Down
23 changes: 23 additions & 0 deletions packages/rest/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions packages/rest/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
"debug": "^4.1.1",
"express": "^4.17.1",
"http-errors": "^1.7.3",
"json-schema-compare": "^0.2.2",
"js-yaml": "^3.13.1",
"lodash": "^4.17.15",
"on-finished": "^2.3.0",
Expand All @@ -57,6 +58,7 @@
"@loopback/repository": "^2.1.1",
"@loopback/testlab": "^3.0.1",
"@types/debug": "^4.1.5",
"@types/json-schema-compare": "^0.2.0",
"@types/js-yaml": "^3.12.3",
"@types/lodash": "^4.14.150",
"@types/multer": "^1.4.3",
Expand Down
160 changes: 159 additions & 1 deletion packages/rest/src/__tests__/integration/rest.server.integration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
// License text available at https://opensource.org/licenses/MIT

import {Application} from '@loopback/core';
import {anOpenApiSpec, anOperationSpec} from '@loopback/openapi-spec-builder';
import {
aComponentsSpec,
anOpenApiSpec,
anOperationSpec,
} from '@loopback/openapi-spec-builder';
import {
createClientForHandler,
createRestAppClient,
Expand Down Expand Up @@ -875,6 +879,160 @@ paths:
await server.stop();
});

it('disables consolidator if openApiSpec.consolidate option is set to false', async () => {
const options = {openApiSpec: {consolidate: false}};
const server = await givenAServer({rest: options});

const EXPECTED_SPEC = anOpenApiSpec()
.withOperation(
'get',
'/',
anOperationSpec().withResponse(200, {
description: 'Example',
content: {
'application/json': {
schema: {
title: 'loopback.example',
properties: {
test: {
type: 'string',
},
},
},
},
},
}),
)
.build();

server.route('get', '/', EXPECTED_SPEC.paths['/'].get, () => {});

await server.start();
const spec = await server.getApiSpec();
expect(spec).to.eql(EXPECTED_SPEC);
await server.stop();
});

it('runs consolidator if openApiSpec.consolidate option is set to true', async () => {
const options = {openApiSpec: {consolidate: true}};
const server = await givenAServer({rest: options});

const EXPECTED_SPEC = anOpenApiSpec()
.withOperation(
'get',
'/',
anOperationSpec().withResponse(200, {
description: 'Example',
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/loopback.example',
},
},
},
}),
)
.withComponents(
aComponentsSpec().withSchema('loopback.example', {
title: 'loopback.example',
properties: {
test: {
type: 'string',
},
},
}),
)
.build();

server.route(
'get',
'/',
anOperationSpec()
.withResponse(200, {
description: 'Example',
content: {
'application/json': {
schema: {
title: 'loopback.example',
properties: {
test: {
type: 'string',
},
},
},
},
},
})
.build(),
() => {},
);

await server.start();
const spec = await server.getApiSpec();
expect(spec).to.eql(EXPECTED_SPEC);
await server.stop();
});

it('runs consolidator if openApiSpec.consolidate option is undefined', async () => {
const options = {openApiSpec: {consolidate: undefined}};
const server = await givenAServer({rest: options});

const EXPECTED_SPEC = anOpenApiSpec()
.withOperation(
'get',
'/',
anOperationSpec().withResponse(200, {
description: 'Example',
content: {
'application/json': {
schema: {
$ref: '#/components/schemas/loopback.example',
},
},
},
}),
)
.withComponents(
aComponentsSpec().withSchema('loopback.example', {
title: 'loopback.example',
properties: {
test: {
type: 'string',
},
},
}),
)
.build();

server.route(
'get',
'/',
anOperationSpec()
.withResponse(200, {
description: 'Example',
content: {
'application/json': {
schema: {
title: 'loopback.example',
properties: {
test: {
type: 'string',
},
},
},
},
},
})
.build(),
() => {},
);

await server.start();
const spec = await server.getApiSpec();
expect(spec).to.eql(EXPECTED_SPEC);
await server.stop();
});

it('registers controller routes under routes.*', async () => {
const server = await givenAServer();
server.controller(DummyController);
Expand Down
Loading