feat(fromOpenApi): support mapping and filtering operations #57
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| import { normalizeSwaggerPath } from './normalize-swagger-path.js' | ||
|
|
||
| it('replaces swagger path parameters with colons', () => { | ||
| expect(normalizeSwaggerPath('/user/{userId}')).toEqual('/user/:userId') | ||
| expect( | ||
| normalizeSwaggerPath('https://{subdomain}.example.com/{resource}/recent'), | ||
| ).toEqual('https://:subdomain.example.com/:resource/recent') | ||
| }) | ||
|
|
||
| it('returns otherwise normal URL as-is', () => { | ||
| expect(normalizeSwaggerPath('/user/abc-123')).toEqual('/user/abc-123') | ||
| expect( | ||
| normalizeSwaggerPath('https://finance.example.com/reports/recent'), | ||
| ).toEqual('https://finance.example.com/reports/recent') | ||
| }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,179 @@ | ||
| // @vitest-environment happy-dom | ||
| import { fromOpenApi } from '../../src/open-api/from-open-api.js' | ||
| import { createOpenApiSpec } from '../support/create-open-api-spec.js' | ||
| import { InspectedHandler, inspectHandlers } from '../support/inspect.js' | ||
|
|
||
| it('creates handlers based on provided filter', async () => { | ||
| const openApiSpec = createOpenApiSpec({ | ||
| paths: { | ||
| '/numbers': { | ||
| get: { | ||
| responses: { | ||
| 200: { | ||
| description: 'Numbers response', | ||
| content: { | ||
| 'application/json': { | ||
| example: [1, 2, 3], | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| put: { | ||
| responses: { | ||
| 200: { | ||
| description: 'Numbers response', | ||
| content: { | ||
| 'application/json': { | ||
| example: [1, 2, 3], | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| '/orders': { | ||
| get: { | ||
| responses: { | ||
| 200: { | ||
| description: 'Orders response', | ||
| content: { | ||
| 'application/json': { | ||
| example: [{ id: 1 }, { id: 2 }, { id: 3 }], | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }) | ||
|
|
||
| const handlers = await fromOpenApi( | ||
| openApiSpec, | ||
| ({ path, method, operation }) => { | ||
| return path === '/numbers' && method === 'get' ? operation : undefined | ||
| }, | ||
| ) | ||
|
|
||
| const inspectedHandlers = await inspectHandlers(handlers) | ||
| expect(inspectHandlers.length).toBe(1) | ||
| expect(inspectedHandlers).toEqual<InspectedHandler[]>([ | ||
| { | ||
| handler: { | ||
| method: 'GET', | ||
| path: 'http://localhost/numbers', | ||
| }, | ||
| response: { | ||
| status: 200, | ||
| statusText: 'OK', | ||
| headers: expect.arrayContaining([['content-type', 'application/json']]), | ||
| body: JSON.stringify([1, 2, 3]), | ||
| }, | ||
| }, | ||
| ]) | ||
| }) | ||
|
|
||
| it('creates handler with modified response', async () => { | ||
| const openApiSpec = createOpenApiSpec({ | ||
| paths: { | ||
| '/numbers': { | ||
| description: 'Get numbers', | ||
| get: { | ||
| responses: { | ||
| 200: { | ||
| description: 'Numbers response', | ||
| content: { | ||
| 'application/json': { | ||
| example: [1, 2, 3], | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| put: { | ||
| responses: { | ||
| 200: { | ||
| description: 'Numbers response', | ||
| content: { | ||
| 'application/json': { | ||
| example: [1, 2, 3], | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| '/orders': { | ||
| get: { | ||
| responses: { | ||
| 200: { | ||
| description: 'Orders response', | ||
| content: { | ||
| 'application/json': { | ||
| example: [{ id: 1 }, { id: 2 }, { id: 3 }], | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }) | ||
|
|
||
| const handlers = await fromOpenApi( | ||
| openApiSpec, | ||
| ({ path, method, operation }) => { | ||
| return path === '/numbers' && method === 'get' | ||
| ? { | ||
| ...operation, | ||
| responses: { | ||
| 200: { | ||
| description: 'Get numbers response', | ||
| content: { 'application/json': { example: [10] } }, | ||
| }, | ||
| }, | ||
| } | ||
| : operation | ||
| }, | ||
| ) | ||
|
|
||
| expect(await inspectHandlers(handlers)).toEqual<InspectedHandler[]>([ | ||
|
There was a problem hiding this comment. We need to add the request test for There was a problem hiding this comment. hmm it will fail, no? Since I added an extra expect for that to check the handlers length anyway: e3d2391 |
||
| { | ||
| handler: { | ||
| method: 'GET', | ||
| path: 'http://localhost/numbers', | ||
| }, | ||
| response: { | ||
| status: 200, | ||
| statusText: 'OK', | ||
| headers: expect.arrayContaining([['content-type', 'application/json']]), | ||
| body: JSON.stringify([10]), | ||
| }, | ||
| }, | ||
| { | ||
| handler: { | ||
| method: 'PUT', | ||
| path: 'http://localhost/numbers', | ||
| }, | ||
| response: { | ||
| status: 200, | ||
| statusText: 'OK', | ||
| headers: expect.arrayContaining([['content-type', 'application/json']]), | ||
| body: JSON.stringify([1, 2, 3]), | ||
| }, | ||
| }, | ||
| { | ||
| handler: { | ||
| method: 'GET', | ||
| path: 'http://localhost/orders', | ||
| }, | ||
| response: { | ||
| status: 200, | ||
| statusText: 'OK', | ||
| headers: expect.arrayContaining([['content-type', 'application/json']]), | ||
| body: JSON.stringify([{ id: 1 }, { id: 2 }, { id: 3 }]), | ||
| }, | ||
| }, | ||
| ]) | ||
| }) | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's add another test case for mapping the operation. It may look like this:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's a great test! 45df894
I modified response, since operation itself does not contain
pathand that one we are not able to modify in this mapping function