Research/Investigate Strategy on How to Versioning REST API

[ianliuwk1019]

Describe the task To investigate and get some knowledge and understanding on how we can version backend REST API endpoints in the future. It will be good to know how to do this when we have production release that could impact downstream apps.

• What are common strategies for REST API versioning and rolling out new version?
• What are needed at backend Framework endpoints level.
• What are needed from Github Repo level.
• Can AWS API Gateway also do API versioning and how?
• Any other considerations?

Acceptance Criteria

• [ ] Document findings and share with the team
• [ ] second
• [ ] third

Additional context

• Add any other context about the task here.
• Or here

[OlgaLiber2]

@ianliuwk1019 do you foresee us needing new API versions in the near future?

[ianliuwk1019]

Hi @OlgaLiber2 I did not remember exact scenario, but this ticket probably was created when we faced some backend api change that we (me and Catherine) saw would impact prod existing function to not working and could not just push code to main code branch. Maybe it was due to rename api (name/path), or maybe was restructuring api return result, but frontend did not yet have corresponding changes to fit the whole story package.

I never did the versioning implementation for api before so am very unclear how it works as well, probably there are several ways people commonly used.

However, in general, versioning might bring many benefits and we might like to explore it.

It is a good to know how, but not urgently needed.