Skip to content
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.

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

Add /api/swagger or similar endpoint for API documentation when Debug is enabled #89

Open
SamStaijen opened this issue Feb 14, 2025 · 0 comments · May be fixed by #90
Open

Add /api/swagger or similar endpoint for API documentation when Debug is enabled #89

SamStaijen opened this issue Feb 14, 2025 · 0 comments · May be fixed by #90
Assignees
Labels
documentation enhancement Proposes (changes to) a feature maintainability

Comments

@SamStaijen
Copy link
Member

We should add an endpoint, such as /api/swagger, that provides access to the full API documentation when DEBUG is enabled. This should display all available API routes, allowing developers to quickly familiarize themselves with the available endpoints and their functionality.

This endpoint should only be accessible in development (when DEBUG=True) to avoid exposing API documentation in production.

Expected Outcome:

An accessible Swagger UI or similar tool showing all the routes in the API.
Easily navigable documentation for API endpoints to help developers with integration and testing.

Benefits:

Improves the developer experience by providing quick access to up-to-date API routes and documentation.
Helps new developers onboard faster by clearly showing available API features.

@SamStaijen SamStaijen added documentation enhancement Proposes (changes to) a feature maintainability labels Feb 14, 2025
@SamStaijen SamStaijen self-assigned this Feb 14, 2025
@SamStaijen SamStaijen linked a pull request Feb 14, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement Proposes (changes to) a feature maintainability
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant