ipointui_ms v0.0.4
Admin UI Microservice
Overview
This microservice serves endpoints for both the admin UI and the admin UI Tool.
Description
The endpoints provided are as follows:
GET /uiEntities
- For use by the admin UI to produce a menu.
GET /uiDetails?name=restName
- For use by the admin UI for entity content.
GET /uiFullEntities
- For use by the admin UI Tool to get configured menu content.
GET /uiFullDetails?name=restName
- For use by the admin UI Tool to get configured entity content.
POST /ingest
- For use by the admin UI Tool to upload UI meta-data to this microservice.
UI meta-data is saved on changes to the file persistedUI.json
.
The GET
APIs call the required endpoints on the 'model server' to ensure that the UI meta-data matches
what is on the model server. This means that you can upload changes to your model using the ERD tool, and simply
refresh the admin UI or admin UI Tool to pick up these changes.
Configuration
The microservice expects a ./config.properties
file with properties port
- the microservice listening port - and
model_server
- the URL of where the model meta-data is served from.
Running
node index.js