api-docs-automation/example-usage.js

Automated API documentation generator that parses JSDoc comments and stores documentation in MongoDB

/**
 * Example usage of the API Docs Generator package
 * 
 * This file demonstrates how to use the package programmatically
 * in your own Node.js applications.
 */

const { parseRoutesAndUpdateDocs } = require('./dist/index');

async function generateDocumentation() {
  try {
    console.log('🚀 Starting API documentation generation...');
    
    // Generate documentation with custom options
    const results = await parseRoutesAndUpdateDocs({
      routesDir: './routes',
      mongoUri: 'mongodb://localhost:27017/api-docs',
      verbose: true
    });
    
    console.log('\n📊 Generation Results:');
    console.log(`  📄 Files processed: ${results.filesProcessed}`);
    console.log(`  🔍 APIs processed: ${results.apisProcessed}`);
    console.log(`  ✅ New APIs: ${results.newApis}`);
    console.log(`  🔄 Updated APIs: ${results.updatedApis}`);
    console.log(`  ✔️ Unchanged APIs: ${results.unchangedApis}`);
    
    if (results.newApis > 0 || results.updatedApis > 0) {
      console.log('\n🎉 Documentation updated successfully!');
      console.log('💡 You can now access your API documentation at:');
      console.log('   - http://localhost:3000/api/docs');
      console.log('   - http://localhost:3000/api/docs/export/openapi');
    } else {
      console.log('\n✨ No changes detected - documentation is up to date!');
    }
    
  } catch (error) {
    console.error('❌ Error generating documentation:', error.message);
    
    if (error.code === 'ECONNREFUSED') {
      console.error('\n💡 Make sure MongoDB is running:');
      console.error('   - Start MongoDB service');
      console.error('   - Or use a different MongoDB URI');
    }
  }
}

// Run the example
if (require.main === module) {
  generateDocumentation();
}

module.exports = { generateDocumentation };