docs: generate OpenAPI/Swagger documentation (closes #14)

index.js

@@ -7,10 +7,10 @@ const { authenticate } = require('./src/middleware/auth');
 const { requireAdmin } = require('./src/middleware/requireAdmin');
 const adminRouter = require('./src/routes/admin');
 const app = express();
-app.use(express.json());
+const docsRoutes = require('./src/routes/docs');
 const log = childLogger('http');
+app.use(express.json());
 const contractId = process.env.CONTRACT_ID || 'CB7PSJZALNWNX7NLOAM6LOEL4OJZMFPQZJMIYO522ZSACYWXTZIDEDSS';
-
 app.use((req, res, next) => {
   const correlationId = req.headers['x-correlation-id'] || crypto.randomUUID();
   req.correlationId = correlationId;
@@ -35,7 +35,6 @@ app.use((req, res, next) => {
   });
   next();
 });
-
 // Health check endpoint
 app.get('/api/health', (req, res) => {
   res.json({
@@ -44,7 +43,6 @@ app.get('/api/health', (req, res) => {
     timestamp: Date.now(),
   });
 });
-
 // Auth challenge - returns a mock JWT token
 app.post('/api/auth/challenge', (req, res) => {
   const { wallet } = req.body || {};
@@ -53,7 +51,6 @@ app.post('/api/auth/challenge', (req, res) => {
     expiresIn: 3600,
   });
 });
-
 // Protected route - requires Authorization header
 app.get('/api/protected', (req, res) => {
   const authHeader = req.headers.authorization;
@@ -65,30 +62,52 @@ app.get('/api/protected', (req, res) => {
     contract: contractId,
   });
 });
-
 // Analytics routes
 const analyticsRouter = require('./src/routes/analytics');
 app.use('/api/analytics', analyticsRouter);
-
+/**
+ * @openapi
+ * /:
+ *   get:
+ *     summary: Get project metadata
+ *     description: Returns basic project status and the configured Soroban contract ID.
+ *     tags: [System]
+ *     responses:
+ *       200:
+ *         description: Project metadata
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 project:
+ *                   type: string
+ *                   example: Equipchain
+ *                 status:
+ *                   type: string
+ *                   example: Monitoring Meters
+ *                 contract:
+ *                   type: string
+ *                   example: CB7PSJZALNWNX7NLOAM6LOEL4OJZMFPQZJMIYO522ZSACYWXTZIDEDSS
+ */
 app.get('/', (req, res) => {
   res.json({
     project: 'Equipchain',
     status: 'Monitoring Meters',
     contract: contractId,
   });
 });
-
+app.use(docsRoutes);
 app.use('/api/admin', authenticate, requireAdmin, adminRouter);
-
 // Auto-seed sample data in development mode only (not during tests)
 if (process.env.NODE_ENV !== 'test' && process.env.NODE_ENV !== 'production' && process.env.SKIP_SEED !== '1') {
   const { seedReadings } = require('./scripts/seed-readings');
   const count = seedReadings();
   log.info({ readingsSeeded: count }, 'Sample meter readings seeded');
 }
-
 if (require.main === module) {
   app.listen(3000, () => log.info('Equipchain API running'));
 }
+module.exports = app;
 
 module.exports = app;