updates, added swagger to all

Author: pkeffect

app_flask.py

@@ -2,35 +2,84 @@
 import os
 from flask import Flask, jsonify, request
 from flask_cors import CORS
+from flask_restx import Api, Resource, fields
 
 app = Flask(__name__)
-CORS(app)  # Enable CORS for all routes
+# Enable CORS for all routes with explicit origins
+CORS(app, resources={r"/*": {"origins": "*"}}, supports_credentials=True)
+
+# Setup Flask-RESTx
+api = Api(
+    app,
+    version='1.0.0',
+    title='Flask API',
+    description='Flask API Documentation',
+    doc='/docs',  # Set documentation endpoint to /docs as requested
+)
 
 # Get environment or use default
 env = os.environ.get("FLASK_ENV", "development")
 
+# Define namespaces
+ns = api.namespace('', description='Core operations')
+
+# Define models
+service_info_model = api.model('ServiceInfo', {
+    'message': fields.String(example='Hello from Flask!'),
+    'service': fields.String(example='Flask API'),
+    'environment': fields.String(example='development'),
+    'version': fields.String(example='1.0.0')
+})
+
+health_model = api.model('Health', {
+    'status': fields.String(example='healthy'),
+    'service': fields.String(example='Flask API')
+})
+
+echo_model = api.model('Echo', {
+    'echo': fields.Raw(example={'message': 'Hello world', 'data': {'key': 'value'}}),
+    'service': fields.String(example='Flask API')
+})
+
+input_model = api.model('EchoInput', {
+    'message': fields.String(example='Hello world'),
+    'data': fields.Raw(example={'key': 'value'})
+})
+
 
-@app.route("/")
-def hello_flask():
-    return jsonify(
-        {
+@ns.route('/')
+class Root(Resource):
+    @ns.response(200, 'Success', service_info_model)
+    def get(self):
+        """Root endpoint - returns basic service information"""
+        return {
             "message": "Hello from Flask!",
             "service": "Flask API",
             "environment": env,
             "version": "1.0.0",
         }
-    )
 
 
-@app.route("/health")
-def health_check():
-    return jsonify({"status": "healthy", "service": "Flask API"})
+@ns.route('/health')
+class Health(Resource):
+    @ns.response(200, 'Success', health_model)
+    def get(self):
+        """Health check endpoint - returns service health status"""
+        return {"status": "healthy", "service": "Flask API"}
 
 
-@app.route("/echo", methods=["POST"])
-def echo():
-    data = request.get_json()
-    return jsonify({"echo": data, "service": "Flask API"})
+@ns.route('/echo')
+class Echo(Resource):
+    @ns.expect(input_model, validate=True)
+    @ns.response(200, 'Success', echo_model)
+    def post(self):
+        """Echo endpoint - returns the JSON sent in the request"""
+        data = request.get_json()
+        return {"echo": data, "service": "Flask API"}
 
+# Add a plain route outside of RESTx for simple health checks
+@app.route('/ping')
+def ping():
+    return jsonify({"status": "ok"})
 
 # Gunicorn will run this, so no app.run() here.

app_node.js

@@ -1,6 +1,8 @@
 // app_node.js
 const express = require('express');
 const cors = require('cors');
+const swaggerJsDoc = require('swagger-jsdoc');
+const swaggerUi = require('swagger-ui-express');
 const app = express();
 
 // Enable JSON body parsing
@@ -13,6 +15,58 @@ app.use(cors());
 const port = process.env.PORT || 8080;
 const env = process.env.NODE_ENV || 'development';
 
+// Swagger configuration
+const swaggerOptions = {
+  definition: {
+    openapi: '3.0.0',
+    info: {
+      title: 'Node.js Express API',
+      version: '1.0.0',
+      description: 'Node.js Express API Documentation',
+      contact: {
+        name: 'API Support'
+      }
+    },
+    servers: [
+      {
+        url: `http://localhost:${port}`,
+        description: 'Development server'
+      }
+    ]
+  },
+  apis: ['./app_node.js'] // Path to the API docs
+};
+
+const swaggerDocs = swaggerJsDoc(swaggerOptions);
+app.use('/docs', swaggerUi.serve, swaggerUi.setup(swaggerDocs));
+
+/**
+ * @swagger
+ * /:
+ *   get:
+ *     summary: Root endpoint
+ *     description: Returns basic information about the service
+ *     responses:
+ *       200:
+ *         description: Basic service information
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 message:
+ *                   type: string
+ *                   example: Hello from Node.js Express!
+ *                 service:
+ *                   type: string
+ *                   example: Node.js Express API
+ *                 environment:
+ *                   type: string
+ *                   example: development
+ *                 version:
+ *                   type: string
+ *                   example: 1.0.0
+ */
 app.get('/', (req, res) => {
   res.json({
     message: 'Hello from Node.js Express!',
@@ -22,13 +76,68 @@ app.get('/', (req, res) => {
   });
 });
 
+/**
+ * @swagger
+ * /health:
+ *   get:
+ *     summary: Health check endpoint
+ *     description: Returns the health status of the service
+ *     responses:
+ *       200:
+ *         description: Service health status
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 status:
+ *                   type: string
+ *                   example: healthy
+ *                 service:
+ *                   type: string
+ *                   example: Node.js Express API
+ */
 app.get('/health', (req, res) => {
   res.json({
     status: 'healthy',
     service: 'Node.js Express API'
   });
 });
 
+/**
+ * @swagger
+ * /echo:
+ *   post:
+ *     summary: Echo endpoint
+ *     description: Returns the JSON sent in the request
+ *     requestBody:
+ *       required: true
+ *       content:
+ *         application/json:
+ *           schema:
+ *             type: object
+ *             example: 
+ *               message: Hello world
+ *               data: 
+ *                 key: value
+ *     responses:
+ *       200:
+ *         description: Echoed response
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 echo:
+ *                   type: object
+ *                   example: 
+ *                     message: Hello world
+ *                     data: 
+ *                       key: value
+ *                 service:
+ *                   type: string
+ *                   example: Node.js Express API
+ */
 app.post('/echo', (req, res) => {
   res.json({
     echo: req.body,

compose.yml

@@ -32,25 +32,24 @@ services:
     build:
       context: .
     container_name: web_flask_dev
-    stdin_open: true # Keep stdin open
-    tty: true        # Allocate a pseudo-TTY
+    stdin_open: true
+    tty: true
     env_file:
-      - ./.env       # Load variables from a local .env file
+      - ./.env
     environment:
       - FLASK_ENV=development
       - PORT=8080
     ports:
-      - "8082:8080"  # Map host 8082 to container 8080
+      - "8082:8080"  # Make sure this binding is correct
     volumes:
       - .:/app:rw
-    command: ["gunicorn", "-w", "1", "--bind", "0.0.0.0:8080", "--reload", "app_flask:app"]
+    command: ["gunicorn", "--bind", "0.0.0.0:8080", "--reload", "app_flask:app"]
     healthcheck:
-      test: ["CMD", "/usr/local/bin/healthcheck.sh"]
+      test: ["CMD", "curl", "-f", "http://localhost:8080/ping"]
       interval: 30s
       timeout: 10s
       retries: 3
       start_period: 10s
-    init: true       # Use an init system like tini    
     restart: unless-stopped
     networks:
       - dev-network