Skip to content

Add Swagger API documentation #267

Description

@Kalaiselvan23

I noticed that the API (both the mock API and the main project) does not yet have Swagger documentation. I believe adding OpenAPI/Swagger documentation would greatly benefit both contributors and users by making the API easier to understand and integrate.

I would love to contribute by:
✅ Setting up Swagger UI for both the mock API and the main project API.
✅ Defining endpoints, request parameters, and expected responses.
✅ Ensuring documentation stays updated with future API changes.

Would you be open to this contribution? Also, do you have any specific guidelines or preferences for the documentation setup? Looking forward to your thoughts!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions