Swagger and redis cached CRUD

README
Cleanup

Author: rxcod9

README.md

@@ -1 +1,93 @@
 # php-swoole-crud-microservice
+
+## Overview
+
+A high-performance CRUD microservice built with PHP and Swoole, featuring MySQL, Redis, Prometheus, Grafana, Caddy, and Swagger UI integration. Designed for scalable, observable, and containerized deployments.
+
+## Features
+
+- Fast HTTP server powered by Swoole
+- MySQL database with connection pooling
+- Redis caching and pooling
+- Metrics endpoint for Prometheus
+- Grafana dashboards for monitoring
+- Caddy for HTTPS and reverse proxy
+- Swagger UI for API documentation
+- Health checks for all services
+
+## Getting Started
+
+### Prerequisites
+
+- Docker & Docker Compose
+
+### Quick Start
+
+```bash
+# Install composer
+composer install
+
+# Start all services in detached mode
+docker compose up -d --build
+```
+
+### Database Migration
+
+```bash
+# Run migrations inside the app container
+docker compose exec app php scripts/migrate.php
+```
+
+### API Documentation
+
+```bash
+# Generate OpenAPI spec
+php bin/generate-swagger.php
+```
+
+Visit Swagger http://localhost:8080
+
+![Preview](cover.png)
+
+### Example API Usage
+
+```bash
+# Create a user
+curl -s -X POST http://localhost:9501/users \
+    -H 'Content-Type: application/json' \
+    -d '{"name":"alice","email":"alice@example.com"}'
+
+# Get all users
+curl -s -X GET http://localhost:9501/users -H 'Content-Type: application/json' | jq
+
+# Get a user by ID
+curl -s -X GET http://localhost:9501/users/1 -H 'Content-Type: application/json' | jq
+
+# Update a user
+curl -i -X PUT http://localhost:9501/users/1 \
+    -H 'Content-Type: application/json' \
+    -d '{"name":"alice-updated","email":"alice-updated@example.com"}'
+
+# Delete a user
+curl -i -X DELETE http://localhost:9501/users/1 -H 'Content-Type: application/json'
+```
+
+### Benchmarking
+
+```bash
+# Run ApacheBench for health check endpoint
+ab -n 100000 -c 100 -v 4 http://localhost:9501/users/1 2>&1 | tee ab.log
+```
+
+### Monitoring
+
+- Prometheus scrapes metrics from the app and MySQL exporter.
+- Grafana visualizes metrics (default port: 3000).
+
+### Environment Variables
+
+See `docker-compose.yml` for all configurable options.
+
+## License
+
+MIT

bin/generate-swagger.php

@@ -0,0 +1,20 @@
+#!/usr/bin/env php
+<?php
+require __DIR__ . '/../vendor/autoload.php';
+
+use OpenApi\Generator;
+
+$output = __DIR__ . '/../public/swagger.json';
+
+// ✅ instantiate generator and call generate()
+$generator = new Generator();
+print "Generating Swagger JSON... \n";
+
+$openapi = $generator->generate([__DIR__ . '/../src/']);
+
+file_put_contents(
+    $output,
+    $openapi->toJson(JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES)
+);
+
+echo "✅ Swagger JSON generated at $output\n";

composer.json

@@ -11,11 +11,13 @@
     "phpmd/phpmd": "^2.15",
     "phpstan/phpstan": "^2.1",
     "phpunit/phpunit": "^10",
-    "squizlabs/php_codesniffer": "^3.13"
+    "squizlabs/php_codesniffer": "^3.13",
+    "zircote/swagger-php": "^5.3"
   },
   "scripts": {
     "start": "php public/index.php",
     "test": "vendor/bin/phpunit",
+    "openapi:generate": "vendor/bin/openapi --output public/openapi.json src",
     "cs": "vendor/bin/phpcs -p --standard=phpcs.xml",
     "cbf": "vendor/bin/phpcbf -p --standard=phpcs.xml"
   },