10000 Add Swagger API documentation · Issue #267 · lugenx/ecohabit · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add Swagger API documentation #267

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
Kalaiselvan23 opened this issue Jan 31, 2025 · 70C1 ; 0 comments
Open

Add Swagger API documentation #267

Kalaiselvan23 opened this issue Jan 31, 2025 · 0 comments

Comments

@Kalaiselvan23
Copy link

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!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Kalaiselvan23
0