Skip to content

MockServer JSONAPI version#494

Open
jackiekircher wants to merge 4 commits into
mainfrom
mock-server-jsonapi-version
Open

MockServer JSONAPI version#494
jackiekircher wants to merge 4 commits into
mainfrom
mock-server-jsonapi-version

Conversation

@jackiekircher
Copy link
Copy Markdown
Contributor

return JSONAPI version in MockServer responses

this version is configurable when creating the mock server via the
jsonapiVersion option. It will only be included in responses
leveraging the backend store - if you are using responseOverrides, then
you should provide the version in your mocked response as needed. This
enables mixed version responses in a single MockServer (e.g. if you are
migratiing some endpoints to another version).

if using the provided serverResponse utility to compose your response
overrides, you can pass the version in via a new options parameter

mockServer.responseOverrides = [
  {
    path: '/users/1',
    method: 'GET',
    response: (mockServer) => serverResponse(mockServer.store.getOne('users', 1), { version: '1.0' }),
  }
]

this version is configurable when creating the mock server via the
`jsonapiVersion` option. It will only be included in responses
leveraging the backend store - if you are using responseOverrides, then
you should provide the version in your mocked response as needed. This
enables mixed version responses in a single MockServer (e.g. if you are
migratiing some endpoints to another version).

if using the provided `serverResponse` utility to compose your response
overrides, you can pass the version in via a new options parameter

```js
mockServer.responseOverrides = [
  {
    path: '/users/1',
    method: 'GET',
    response: (mockServer) => serverResponse(mockServer.store.getOne('users', 1), { version: '1.0' }),
  }
]
```
@jackiekircher jackiekircher force-pushed the mock-server-jsonapi-version branch from 9ae6483 to 30ca468 Compare November 4, 2025 17:51
@jackiekircher jackiekircher force-pushed the mock-server-jsonapi-version branch from 5e6559b to 0c3f7f9 Compare November 4, 2025 17:59
@jackiekircher jackiekircher changed the base branch from main to 7.0-stable November 4, 2025 18:19
@jackiekircher jackiekircher changed the base branch from 7.0-stable to main November 4, 2025 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant