API Annotations
Link UI screens to API operations. Define read and write directions, bind endpoints, and document how data flows between the interface and backend services.
API annotations connect your UI screens to the backend operations that supply and receive data. By annotating a screen with API details, you document the full data path from the user interface through to the service layer, completing the lineage chain from model to projection to UI to API.
Why Annotate with APIs
Complete Lineage
Trace data from the model through projections and UI all the way to the API contract
Developer Handoff
Frontend developers see exactly which endpoints to call for each screen
Impact Analysis
Changes to an API endpoint surface in the architecture map, showing affected screens
Read and Write Direction
Each API annotation specifies a direction that describes how data flows relative to the screen:
Binding an Endpoint
How Annotations Appear
API annotations are visible in several places:
| Location | What You See |
|---|---|
| UI View editor | A small API badge on each annotated page tab |
| Architecture map | Integration materialisation edges from UI nodes to API nodes |
| Published viewer | API details in the projection page's UI View tab |
| Impact analysis | Affected screens listed when an endpoint changes |