Sometimes during development it might be necessary to work with mocked data. This is especially necessary when developing new features in parallel where backend and frontend are involved. In the PWA we supply a mocking mechanism so the frontend team can start implementation with mocked data until the backend implementation is finished.
Mocking complete REST responses can be configured in environment.ts for calls, that do not yet exist in the REST API during development.
The property apiMockPaths is an array of regular expressions for paths.
The following configuration example will mock all CMS calls.
apiMockPaths: ['^cms/.*'],
Tip
With PWA version 5.2.0 a filtering for matrix parameters (e.g. /cms;pgid=JdbSDW8rrqSRpGO4S7o0b4AK0000/includes) was introduces.
This way personalized REST calls can be mocked now as well with file path without the matrix parameter.
The configuration would look like this.
apiMockPaths: ['^cms.*/.*'],
Mocked data is put in the folder assets/mock-data/. The path is the full path to the endpoint of the service without additional arguments. The JSON response is put into a file called get.json in the respective folder.
Example path to a homepage include mock file.
src/assets/mock-data/cms/includes/include.homepage.content.pagelet2-Include/get.json
Switching to mocked REST API calls is done by the MockInterceptor which reads the configuration and acts accordingly.
Mocked REST calls will be logged to the browser console similar to this example.
