feat(GOV-009): 建立后端契约与健康检查

2026-08-13 17:26:51 +08:00
parent 3fc703de0b
commit 420aa22342
32 changed files with 1625 additions and 8 deletions
@@ -0,0 +1,74 @@
+{
+  "components": {
+    "schemas": {
+      "DependencyHealthDto": {
+        "properties": {
+          "detail": { "type": "string" },
+          "status": {
+            "enum": ["healthy", "unavailable", "disabled"],
+            "type": "string"
+          }
+        },
+        "required": ["status", "detail"],
+        "type": "object"
+      },
+      "HealthDependenciesDto": {
+        "properties": {
+          "mysql": { "$ref": "#/components/schemas/DependencyHealthDto" },
+          "redis": { "$ref": "#/components/schemas/DependencyHealthDto" },
+          "rocketMq": { "$ref": "#/components/schemas/DependencyHealthDto" }
+        },
+        "required": ["redis", "mysql", "rocketMq"],
+        "type": "object"
+      },
+      "HealthResponseDto": {
+        "properties": {
+          "checkedAt": { "format": "date-time", "type": "string" },
+          "dependencies": {
+            "$ref": "#/components/schemas/HealthDependenciesDto"
+          },
+          "process": { "enum": ["api"], "type": "string" },
+          "status": { "enum": ["healthy", "unavailable"], "type": "string" }
+        },
+        "required": ["status", "process", "checkedAt", "dependencies"],
+        "type": "object"
+      }
+    }
+  },
+  "info": {
+    "contact": {},
+    "description": "",
+    "title": "A 股市场分析工具 API",
+    "version": "0.0.8-draft"
+  },
+  "openapi": "3.0.0",
+  "paths": {
+    "/api/v1/health": {
+      "get": {
+        "operationId": "HealthController_getHealth",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#/components/schemas/HealthResponseDto" }
+              }
+            },
+            "description": ""
+          },
+          "503": {
+            "content": {
+              "application/json": {
+                "schema": { "$ref": "#/components/schemas/HealthResponseDto" }
+              }
+            },
+            "description": ""
+          }
+        },
+        "tags": ["health"]
+      }
+    }
+  },
+  "servers": [],
+  "tags": []
+}