Single API Design - Githubissues

bcgov / cas-obps

0 stars 0 forks source link

Single API Design #243

Closed pbastia closed 5 months ago

pbastia commented 5 months ago

Design Single API to support registration, reporting and compliance:

Identify endpoints for registration, reporting and compliance.
Identify 3rd party integrations like credits, messaging and payments.
Design service layer to minimize code duplication.
Determine authorization for different user types.
Develop API code guidelines and conventions.

pbastia commented 5 months ago

For the first 2 points, I feel we're not being very agile:

Identify endpoints for registration, reporting and compliance. Identify 3rd party integrations like credits, messaging and payments.

Wouldn't it make more sense that we design and architect the API to support multiple endpoints split into reg, rep, comp; and to be able to integrate easily with 3rd party libraries?

Since we have very few requirements at this point, frontloading the entire route and endpoint design doesn't make sense I feel

DataVillage commented 5 months ago

The advantage of identifying endpoints in advance is understanding where business logic may be shared. For example in the Dev Team Agreements meeting we were discussing users for registration and reporting. There are several similarities in the way users will be handled in the different components. Using a completely agile approach we may be focused on one system component, at the expense of another. Having a big picture from the start may be more efficient. Anyway, I think we need a combination of agile development with some advance planning.

rdromey commented 5 months ago

Split into other tickets.