Description
The project currently lacks interactive API documentation, making it difficult for developers to understand and test available endpoints.
Proposed Solution
Integrate SpringDoc OpenAPI to automatically generate API documentation and provide an interactive Swagger UI.
Tasks
Expected Outcome
- Interactive API documentation UI
- Easy endpoint testing without external tools
- Improved developer experience and API clarity
Additional Context
Swagger/OpenAPI is a standard for REST API documentation and will make the project more accessible for contributors and users.
Description
The project currently lacks interactive API documentation, making it difficult for developers to understand and test available endpoints.
Proposed Solution
Integrate SpringDoc OpenAPI to automatically generate API documentation and provide an interactive Swagger UI.
Tasks
/swagger-ui.htmlor/swagger-ui/index.html@Operation,@Tag, etc.) for better documentationExpected Outcome
Additional Context
Swagger/OpenAPI is a standard for REST API documentation and will make the project more accessible for contributors and users.