Refactor and improve Cloudmos API

[Redm4x]

Refactor the Cloudmos API to enhance usability and maintainability. More and more projects in the akash ecosystem would benefit from using the cloudmos API in their project and this is the ground work for making it more accessible and developer-friendly.

• Improve naming convention (consistent, lowercase, no verbs)
• Refactor endpoint implementations to be more consistent (controller > service) Renamed providers to services for clarity
• Add versioning for backward compatibility (ex: /v1/deployments)
• Add authorization system (allow other projects to use our hosted api, enable CORS?)
• Add api documentation (probably swagger)
• Update cloudmos UI to call the new API
• Monitoring + analytics
• Add documentation to the readme

[Redm4x]

November 28, 2023:

Started working on the api refactor and planning the new api structure (naming/versioning), Looking at the possibility to change the framework (expressjs) for something more modern like Hono.

[Redm4x]

December 5, 2023:

Hono seems like a good option. Currently implementing the OpenAPI/Swagger UI integrations.

[Redm4x]

December 12, 2023:

Going forward with Hono and their Zod/OpenAPI/Swagger intergrations. I'll share the swagger definition with the team for review as soon as it's ready.

[Redm4x]

December 19, 2023:

Still working on a prototype of the new api. Had an issue with date serializing, but it should be fixed in the latest version of Hono [edit: Confirmed Fixed].

[stayForward09]

Thanks with great API routes.

[Redm4x]

January 9, 2024:

The api versioning is implemented. Doing progress on refactoring every endpoints, I deployed a preview url for keeping track of the progress through swagger UI:
https://api-preview.cloudmos.io/v1/swagger

[Redm4x]

January 16, 2024

• Finished almost all route refactoring, only the endpoints for logged in users remain:
  • Public Api Routes ✅
  • Private Dashboard Routes ✅
  • Web3Index Routes ✅
  • User Routes (login/templates/favorites) 🕐
• Improved typescript typing across the board
• Updated the deploy-tool to use new endpoints

Expecting to create a PR this week. I updated the Preview URL with the latest changes.

[Redm4x]

January 23, 2024:

Finished refactoring the user routes (login/templates/favorites) and authorization middlewares. Created a draft PR for self review. I will add documentation to the README and make the PR ready for review today. The api key system is not implemented, but I think it's best to split it into it's own task.

[Redm4x]

January 30, 2024:

PR is in review, created issue #92 to track the remaining tasks (authentitcation system)