Integrate OpenAPI Specification and Implement API Versioning

[FlynnOConnell]

We should adopt the OpenAPI Specification for our API and start versioning our endpoints.

Tasks:

1. OpenAPI Integration:

• [ ] Research and select an appropriate Rust crate or tool for OpenAPI integration (e.g., paperclip, rocket_okapi).
• [ ] Document each API endpoint according to the OpenAPI Specification.
• [ ] Ensure that the API documentation is accessible, preferably via a /docs endpoint, using tools like Swagger UI or ReDocly.
  • [ ] Update the developer documentation to include details about how to update and maintain the OpenAPI documentation.

2. API Versioning:

   • [ ] Decide on a versioning strategy (e.g., URI versioning, Header versioning).
   • [ ] Update current endpoints to conform to the chosen versioning strategy.
   • [ ] Ensure backward compatibility for existing clients during the transition.
   • [ ] Update developer documentation with guidelines on introducing new API versions and deprecating old ones.

3. Testing:

• [ ] Extend existing tests or add new tests to ensure OpenAPI specifications are accurate.
• [ ] Ensure that versioning changes don't break existing tests and functionalities.

[LukeBrandon]

Something to look into: https://github.com/juhaku/utoipa

[Chizobaonorh]

Helloooo, I am very much interested in working on this project.