Add Swagger/OpenAPI documentation for Analytics API #217
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Install swagger-jsdoc and swagger-ui-express - Create comprehensive OpenAPI configuration with API overview - Document analytics endpoint with detailed JSDoc annotations - Add schema definitions for all response types (Spotify, Apple, Hoster, etc.) - Create AVAILABLE_QUERIES.md listing all 50+ query endpoints - Expose Swagger UI at /api-docs and OpenAPI spec at /api-docs.json - Make documentation publicly accessible (no auth required) The documentation includes: - All available data sources (Spotify, Apple Podcasts, generic hosters) - Complete parameter definitions with examples - Response schemas with property descriptions - Authentication requirements - CSV export format support - Example usage for common scenarios
Prevents 'Duplicate column name' error when running migrations on a fresh database that already has the column in schema.sql
…ate for examples; streamline server definitions for production and development environments.
…cies in package.json and package-lock.json
…1 and 404 status codes
…nd field descriptions
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #216