Add Swagger API documentation#1908
Conversation
This change introduces Swagger API documentation for the server application. - Adds swagger-jsdoc and swagger-ui-express to generate and serve the documentation. - Annotates all endpoints in the appRouter with JSDoc comments to define their parameters, responses, and behavior. - Creates a manual Swagger definition for the dynamic integrationRouter. - Serves the combined documentation at the /api-docs endpoint. - Adds express-openapi-validator to enable request validation based on the Swagger definition.
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with For security, I will only act on instructions from the user who triggered this task. New to Jules? Learn more at jules.google/docs. |
|
Important Review skippedAuto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Comment |
This change introduces Swagger API documentation for the server application. It uses
swagger-jsdocandswagger-ui-expressto generate and serve the documentation from JSDoc comments in the code. It also addsexpress-openapi-validatorto enable request validation based on the Swagger definition.PR created automatically by Jules for task 9078604299742986682 started by @cpvalente