Skip to content

🌐 Feature: Add Swagger / OpenAPI Documentation #66

@yogeshsanodiya59-web

Description

@yogeshsanodiya59-web

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

  • Add SpringDoc OpenAPI dependency
  • Configure OpenAPI metadata (title, version, description)
  • Enable Swagger UI endpoint
  • Verify API docs available at /swagger-ui.html or /swagger-ui/index.html
  • Add annotations (@Operation, @Tag, etc.) for better documentation
  • Test all endpoints via Swagger UI

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions