Merged
Conversation
This commit introduces Swagger UI for interactive API documentation and a Postman collection for easy API testing. - Adds `swagger-ui-express` and `swagger-jsdoc` to handle documentation generation and serving. - Implements JSDoc comments across all API routes in `src/routes/api.js` to define the API specification. - Creates a new endpoint, `/api-docs`, to serve the interactive Swagger UI. The UI is pre-configured to use the master API key for immediate testing. - Generates a `whatsapp_api_collection.json` file in the root directory. The collection includes all endpoints and a pre-request script to manage the `X-MASTER-KEY` header automatically. - Updates `README.md` with a new "API Documentation" section, explaining how to access the Swagger UI and import the Postman collection.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This commit introduces Swagger UI for interactive API documentation and a Postman collection for easy API testing.
swagger-ui-expressandswagger-jsdocto handle documentation generation and serving.src/routes/api.jsto define the API specification./api-docs, to serve the interactive Swagger UI. The UI is pre-configured to use the master API key for immediate testing.whatsapp_api_collection.jsonfile in the root directory. The collection includes all endpoints and a pre-request script to manage theX-MASTER-KEYheader automatically.README.mdwith a new "API Documentation" section, explaining how to access the Swagger UI and import the Postman collection.