@springworks/static-api-server NPM | npm.io

3005.318.0 • Published 19 days ago

Install

Weekly downloads

987

License

-

Repository

Last release

19 days ago

@springworks/static-api-server

A static version of an API, responding with fixtures. Useful to mimic behavior of an actual API server, but with static fixture responses instead.

yarn add @springworks/static-api-server

Usage

Send requests to API and get matching fixtures back:

import static_api_server from '@springworks/static-api-server';
import { createFixtureLoader } from '@springworks/fixture-loader';

const created_server = await static_api_server.createServer({
  swagger_spec: swagger_spec,
  fixture_loader: createFixtureLoader('./path-to-fixtures'),
  host: 'localhost',
  port: 3001,
  output_validation: false,
});

await created_server.start();

// Send requests to server, which will respond with successful status code and fixture

// Call `stop()` when done
await created_server.stop();

API

`createServer({ swagger_spec, fixture_loader, host, port, output_validation })`

output_validation is optional and defaults to off. When enabled, all responses are validated against the API specification using hapi-sov.

Creates and configures a Hapi server. Routes defined in swagger_spec will be matched with fixtures from fixture_loader.

Returns a Hapi server instance.

server.replaceFixtures(verb, route, fixtures)

Gives you the ability to adjust the mocks for certain calls. fixtures is an array of fixtures, where each element in the array corresponds to the call count of the invocation. Meaning, request number 1 will receive fixture at index 0, and so on. This is an instance method on the created server object. NOTE! Make sure to enable output_validation in the server options if using shadow fixtures! This ensures that your mocked fixtures validate against the swagger spec.

server.shadowFixtures(verb, route, fixtures)

Gives you the ability to adjust the mocks for certain calls. fixtures is an array of fixtures, where each element in the array corresponds to the call count of the invocation. This method uses lodash.merge for each fixture call. If you want to replace this fixture, please use replaceFixtures. Meaning, request number 1 will receive fixture at index 0, and so on. This is an instance method on the created server object. NOTE! Make sure to enable output_validation in the server options if using shadow fixtures! This ensures that your mocked fixtures validate against the swagger spec.

server.purgeShadowFixtures()

Purge any existing shadow fixtures. Useful as an afterEach() during testing.

@hapi/boom @hapi/hapi @springworks/error-factory @springworks/fixture-loader @springworks/hapi-openapi @springworks/hapi-sov @springworks/input-validator @springworks/schema-validator lodash

@infinitebrahmanuniverse/nolb-_spr @everything-registry/sub-chunk-859 @zalastax/nolb-_spr

19 days ago

2 months ago

2 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

4 months ago

4 months ago

5 months ago

10 months ago

10 months ago

7 months ago

8 months ago

8 months ago

11 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago

8 years ago