How to model an API architecture

[MatthiasVDE]

I search some examples of the modelling of an API architecture in EA. Starting from the canonical/logical data model, over inner API's to consumer API's and the front-end.

The intention is to describe a layered design:

- Front-end (HTML5 /JS)
- Consumer API
- Consumer Java code
- Inner API
- Inner Java code
- ESB
- Legacy System
- Database

The data model is located between the ESB and the Inner Java Code, because the ESB will translate the legacy data to the new data model that will be accessed through the API's. For each attribute we have to keep track of the source attribute, in order to create a mapping table afterwards.

[MatthiasVDE]

No one?

[qwerty]

Your question might simply be a bit too broad. I have seen books about that. And I don't mean brochures.

q.

[lfgcasey]

We've modeled our ESBs and API Gateways typically as Components & Interfaces, encapsulating them within Execution Environments when appropriate. Depending on how many individual methods are exposed by the API, you can either have one Interface per method, or you can group the methods into logical sets, with each set having its own corresponding Interface object. The Components can then be dissected into Classes and the Classes linked to the corresponding Components.

Hope that helps!

[Sunshine]

You should read a UML book or two there are plenty on the topic.
To answer your broad question;
- Front-end (HTML5 /JS) -> Screens, Classes and operations
- Consumer API -> Interfaces and operations
- Consumer Java code -> Classes, attributes and operations
- Inner API -> Interface and operations
- Inner Java code -> Classes, attributes and operations
- ESB -> Component. Data mappings-> Classes
- Legacy System -> Component s
- Database -> Components. Schemas-> ERD