Public Folder

What is the public folder?

During mocking, files within the public folder will be served based on their relative file path. For example, given the following files:

  • index.html

  • users/1.json

GET requests for / and /index.html will map to the file index.html .

GET requests for /users/1 and /users/1.json will map to users/1.json

Based on the file extension, the file will also be served with a related conten type. For example:

/users/1 will set a response header of Content-Type: application/json

Defaults

Unless otherwise specified:

  • status_code defaults to 200

  • Response header Content-Type will be inferred from the fixture file extension

Why use the public folder?

  • Quick way to mock a request in the case where a specific response is difficult to record

  • Serve assets that otherwise should not be recorded

Last updated

Was this helpful?