Definitions and Explanations
User
User is the important entity for the Access management on this platform. The user can login to the platform to use the features both via API and UI.
UserRole
User role indicates the role for the user. Access management for this platform is role based and the user is mapped to one of the roles as mentioned below,
- ADMIN - A person who has access to all features of the platform and has control over the other users of the platform for access management. It is the super-user behaviour.
- MANAGER - A person who has access to all features of the platform.
- VIEWER - A person who has read-only access to the platform.
Mock
This is the primary resource of the platform.
A mock can have a name, description, route, httpMethod and so on as mentioned in the API model of the Mock entity.
The structure of mock entity mimics the actual endpoint. The mocks will be setup by the user via API or UI based upon their requirements. Whenever the actual endpoints are called, the request is intercepted, and the stored mocked entity is called to test the API behaviour and expected response results.
Platform Settings
This entity contains the feature control of the platform for every user.
Currently there is a single platform setting common for all users but in the upcoming releases these platform settings will be converted to each user-specific setting and this will be permitted/restricted by the access management policies decided by the developers who are using the tool.
Some of the current settings include export/import of mocks, auto flush of recycle bin and so on.