Build a tool that automatically generates interactive API documentation from code comments and annotations, similar to Swagger/OpenAPI.

Project Checklist

• Parse code comments/annotations for API endpoint information
• Extract route definitions, parameters, and response schemas
• Generate OpenAPI/Swagger specification file
• Create interactive documentation UI
• Support multiple HTTP methods and status codes
• Include request/response examples

Bonus Project Checklist Items

• Add “Try it out” functionality to test endpoints
• Support authentication documentation
• Generate code examples in multiple languages
• Add versioning support
• Implement automatic schema validation
• Create PDF export functionality

Inspiration (Any companies/libraries similar)

• Swagger UI
• Postman Documentation
• Redoc

Hint/Code snippet to start

/**
 * @route POST /api/users
 * @description Create a new user
 * @param {string} email - User email address
 * @param {string} password - User password
 * @returns {object} 201 - Created user object
 * @returns {object} 400 - Validation error
 */
app.post('/api/users', async (req, res) => {
  // Implementation
});

function generateOpenAPISpec(routes) {
  return {
    openapi: '3.0.0',
    info: { title: 'API', version: '1.0.0' },
    paths: routes.reduce((paths, route) => {
      paths[route.path] = {
        [route.method]: {
          summary: route.description,
          parameters: route.params,
          responses: route.responses
        }
      };
      return paths;
    }, {})
  };
}