Mocking #

OpenAPI allows to include examples in the API definition. FLAT uses response examples to implement an easy to use mock server.

If mocking is enabled via the $FLAT_ALLOW_MOCKING environment variable it can be activated by the client with the HTTP header

Mock: true

If given, FLAT will look in the examples of the API path’s 200 responses section for an example with a content-type that matches the inbound Accept header.

Mocked responses from upstream work just the same way.

Configuration #

To avoid accidentally running on mocks in production, mocking has to be explicitly activated with the $FLAT_ALLOW_MOCKING environment variable (default false):

FLAT_ALLOW_MOCKING=true

→ Defining Environment Variables

Example #

→ Using the Built-in Mocking