@sap-ux/ui5-middleware-fe-mockserver
Features
The SAP Fiori - UI5 middleware for the Fiori elements mock server is a middleware extension for the UI5 Tooling. As an alternative to proxying OData requests to a live backend, it supports loading mock data for OData v2/v4 requests for supported Fiori elements templates. As the mock server runs locally without requiring a network connection to a backend system, it is useful for development and test scenarios.
Installation
npm
npm install --save-dev @sap-ux/ui5-middleware-fe-mockserver
yarn
yarn add @sap-ux/ui5-middleware-fe-mockserver --dev
pnpm
pnpm add @sap-ux/ui5-middleware-fe-mockserver --dev
Usage
In order to use the mock server, the npm module @sap-ux/ui5-middleware-fe-mockserver
needs to be added as devDependency to package.json
, and a valid ui5.yaml
configuration needs to be provided.
Entries in package.json
[..]
"devDependencies": {
"@sap-ux/ui5-middleware-fe-mockserver": "^2"
}
[..]
Example for a yaml configuration file
specVersion: '3.0'
metadata:
name: <NAME>
type: application
server:
customMiddleware:
- name: sap-fe-mockserver
mountPath: /
afterMiddleware: compression
configuration:
annotations:
- localPath: './webapp/localService/myServiceAnnotation.xml'
urlPath: '/sap/opu/odata/IWFND/CATALOGSERVICE;v=2/Annotations*'
services:
- urlPath: '/sap/opu/odata/sap/<SERVICE_NAME>'
metadataPath: './webapp/localService/metadata.xml'
mockdataPath: './webapp/localService/data'
- urlPath: '/sap/opu/odata/sap/<OTHER_SERVICE_NAME>'
metadataPath: './webapp/localService/other_metadata.xml'
mockdataPath: './webapp/localService/data'
Special case within karma
If you are running the mockserver embedded in karma you need to change the configuration to use
beforeMiddleware: csp
instead of afterMiddleware: compression
Service Configuration
Each service must provide at least two things
- urlPath : where will your service be accessible from
- metadataPath : local path to your metadata file
On top of that you can specify one of the following option
- mockdataPath : the path to the folder containing the mockdata files
- generateMockData : whether or not you want to use automatically generated mockdata
- forceNullableValuesToNull: determine if nullable properties should be generated as null or with a default value (defaults to false)
Additional option are available either per service of for all services if defined globally
-
debug : toggle the debug mode
-
logger: specify the logger to use, by default it will use the @ui5/logger
-
watch : toggle the watch mode, the mockserver will restart the service where data or metadata have changed
-
noETag : disable ETag support on metadata
-
strictKeyMode : disable the default "loose" mode for the key matching.
By default the mockserver will try many ways to match an entityset with its navigation property, which can result in some rather loose join of data. In case you have a very well defined mockdata and you feel the mockserver is returning too much data, you can enable this feature.
-
contextBasedIsolation : enable the support of "tenants" at the URL level.
Tenants allow you to work on the same app with dedicated, isolated tenant data.
Tenants are always available by using ?sap-client in your application url, however by enabling this setting you can also enable a specific path based tenant by prepending /tenant-xxx at the very start of your service call.
On top of the standard json file loading, when using tenants we will automatically try to fetch a specific json data from a file including the tenant ID in the name.
For instance if you have an entity called Product
you can have a Product.json
file containing the standard data and a Product-testErrorXXX.json
file for a specific tenant called testErrorXXX.
If you don't have a tenant specific file, the mockserver will fallback to the standard file.
You can also define static annotation file using the annotations
entry, each annotation must provide
- urlPath : where will your annotation be accessible from
- localPath : local path to your annotation file
Documentation
You can find more details on how to influence the mockserver behavior for mockdata by checking the documentation under Defining Mockdata
We also have samples available in the samples folder
Sample application
See the usage in demo apps SAP Fiori sample apps
Support
Join the SAP Fiori tools Community. Ask Questions, Read the Latest Blogs, Explore Content.
Please assign tag: SAP Fiori tools
To log an issue with SAP Fiori tools, please see Contact SAP Support.
Keywords
Mockserver, Middleware