Question 1

How do I mock an API endpoint that returns JSON based on query parameters in Smoke?

Accepted Answer

Use file naming with $ for query matching, like 'get_api#data$filter=active.json', or create a .json_ template file to access the query object dynamically—e.g., {{query.filter}} to customize responses.

Question 2

Smoke vs JSON Server: which is better for quick API mocking?

Accepted Answer

Smoke is ideal for file-based, convention-over-configuration mocking with recording capabilities, while JSON Server provides a fake REST API with a database-like backend. Choose Smoke for simplicity and prototyping; JSON Server for relational data mocking.

Question 3

Can Smoke handle authentication like JWT tokens in mocks?

Accepted Answer

Yes, use JavaScript mocks or middleware hooks to check headers—e.g., in a .js file, access data.headers['authorization'] and return 401 if invalid. Middleware can also inject or validate tokens per request.

Question 4

How to record API responses from a live backend with Smoke?

Accepted Answer

Run 'smoke --record <host>' to proxy unmatched requests and save responses as mock files. Adjust with --depth for folder structure and --save-headers to include response metadata, ideal for creating offline mocks.

Question 5

Does Smoke support mocking WebSocket connections or GraphQL?

Accepted Answer

No, Smoke is designed for HTTP/REST APIs only and lacks native support for WebSocket or GraphQL protocols. For those, consider specialized tools like Mock Service Worker or GraphQL mock servers.

Question 6

How to organize mocks for different test scenarios like errors or slow responses?

Accepted Answer

Use mock sets with the --set option: suffix files with __set-name (e.g., 'api#data__error.json') and switch between sets via CLI to simulate error states, or use JavaScript mocks to add delays or failures.

smoke

What is smoke?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions