hana-cli/test-swagger.js

HANA Developer Command Line Interface

#!/usr/bin/env node
/**
 * Simple script to test the Swagger endpoint
 * Run this to verify Swagger is working
 */

console.log('\n=================================')
console.log('🧪 Testing Swagger Implementation')
console.log('=================================\n')

console.log('To test the Swagger endpoint:')
console.log('\n1. Start the UI server:')
console.log('   node bin/cli.js ui\n')
console.log('2. Open your browser to:')
console.log('   http://localhost:3010/api-docs\n')
console.log('3. You should see the Swagger UI with all documented endpoints\n')
console.log('4. To get the raw OpenAPI spec:')
console.log('   http://localhost:3010/api-docs.json\n')

console.log('Documented endpoints include:')
console.log('  • Configuration: GET/PUT /')
console.log('  • HANA System: GET /hana')
console.log('  • HANA Objects: GET /hana/tables, /hana/views, /hana/schemas, etc.')
console.log('  • HANA Inspect: GET /hana/inspectTable, /hana/inspectView, etc.')
console.log('  • HDI: GET /hana/containers')
console.log('  • Cloud Services: GET /hana/hdi, /hana/sbss, /hana/schemaInstances, etc.')
console.log('  • Documentation: GET /docs/readme, /docs/changelog')
console.log('  • And more...\n')

console.log('✅ Swagger has been implemented with:')
console.log('   - swagger-jsdoc for auto-generation from JSDoc comments')
console.log('   - swagger-ui-express for the interactive UI')
console.log('   - Full JSDoc annotations on all route endpoints')
console.log('   - OpenAPI 3.0 specification\n')