OpenAPI

FastAPI will take care of generating the documentation page. We can choose from different UIs:

1. ReDoc
   with a CLI that lints our OpenAPI spec
2. SwaggerUI

ReDoc has premium services and we need to check if although it looks more beautiful it's worth to opt in to their free stage or if SwaggerUI is enough.

We follow the API first principle. Meaning that we define our API first, before generating the backend stub and coding its implementation.

Our OpenAPI spec acts like a single source of truth (SSOT). Test cases are generated from the OpenAPI spec and the backend implementation needs to adhere to them.

Our design follows a few different design guidelines:

1. Zalando RESTful API Guidelines
2. Microsoft API Design Best Practices
3. Web API Checklist by Mathieu Fenniak

1. We don't use kebab case and snake case instead as the dash can easily introduce bugs as it can be interpreted as a minus sign.
2. We might want to use CalVer (Read github notes)