diff --git a/.gitignore b/.gitignore index 1d5f119..469e8f5 100644 --- a/.gitignore +++ b/.gitignore @@ -7,10 +7,6 @@ __pycache__/ *.pyc *$py.class -# Database -db.sqlite3 -*.sqlite3 -*.sqlite # Logs *.log diff --git a/status/templates/status/api_docs.html b/status/templates/status/api_docs.html index 4306815..53fc9a7 100644 --- a/status/templates/status/api_docs.html +++ b/status/templates/status/api_docs.html @@ -1,29 +1,101 @@ -{% extends 'status/base.html' %} - -{% block title %}API说明{% endblock %} - -{% block content %} -
-

API接口说明

-

本系统提供以下RESTful API接口，用于服务状态的上报和查询。

- -
-

认证方式

-
-

目前所有API接口均无需认证，可直接访问。后续版本可能会添加认证机制。

+ + + + + + API说明 - 服务状态监控 + + + + + + + +
+
+
+
+ +

服务状态监控

+
+
+ + 管理后台 + + + API说明 + +
+
+ + 返回首页 + +
+
+

实时监控系统服务运行状态与可靠性

-
- -
-

API端点列表

- -
-

POST /api/checkin/ - 客户端上报接口

-

用于客户端上报服务状态信息。如果服务不存在，系统会自动创建。

+ + + +
+
+

API接口说明

+

本系统提供以下RESTful API接口，用于服务状态的上报和查询。

-
-

请求体示例：

- 
{
+            

+                
认证方式

+                

+                    
目前所有API接口均无需认证，可直接访问。后续版本可能会添加认证机制。

+                

+            

+            
+            

+                
API端点列表

+                
+                

+                    
POST /api/checkin/ - 客户端上报接口

+                    
用于客户端上报服务状态信息。如果服务不存在，系统会自动创建。

+                    
+                    

+                        
请求体示例：

+                        
{
   "service_name": "Web服务",
   "host": "192.168.1.100",
   "port": 80,
@@ -32,25 +104,25 @@
   "response_time": 120.5,
   "message": "连接成功"
 }

-            

-            
-            

-                
响应示例：

-                
{
+                    

+                    
+                    

+                        
响应示例：

+                        
{
   "code": 200,
   "message": "服务状态已更新",
   "service_id": 1
 }

-            

-        

-        
-        

-            
GET /api/services/ - 服务列表查询接口

-            
获取所有服务的列表及其最新状态。

-            
-            

-                
响应示例：

-                
[
+                    

+                

+                
+                

+                    
GET /api/services/ - 服务列表查询接口

+                    
获取所有服务的列表及其最新状态。

+                    
+                    

+                        
响应示例：

+                        
[
   {
     "id": 1,
     "name": "Web服务",
@@ -64,16 +136,16 @@
     "latest_response_time": 120.5
   }
 ]

-            

-        

-        
-        

-            
GET /api/services/{id}/history/ - 服务历史记录查询接口

-            
获取指定服务的历史检测记录。

-            
-            

-                
响应示例：

-                
{
+                    

+                

+                
+                

+                    
GET /api/services/{id}/history/ - 服务历史记录查询接口

+                    
获取指定服务的历史检测记录。

+                    
+                    

+                        
响应示例：

+                        
{
   "count": 1,
   "total_pages": 1,
   "current_page": 1,
@@ -89,42 +161,51 @@
     }
   ]
 }

-            

-        

-        
-        

-            
GET /api/status-summary/ - 状态摘要查询接口

-            
获取所有服务的状态摘要统计信息。

-            
-            

-                
响应示例：

-                
{
+                    

+                

+                
+                

+                    
GET /api/status-summary/ - 状态摘要查询接口

+                    
获取所有服务的状态摘要统计信息。

+                    
+                    

+                        
响应示例：

+                        
{
   "total_services": 10,
   "up_count": 8,
   "down_count": 1,
   "unknown_count": 1
 }

+                    

+                

+            

+            
+            

+                
状态码说明

+                
    
+                    
  • UP: 服务正常运行
    • 
+                    
  • DOWN: 服务不可用
    • 
+                    
  • UNKNOWN: 服务状态未知
    • 
+                

+            

+            
+            

+                
检测类型说明

+                
    
+                    
  • http: HTTP检测
    • 
+                    
  • https: HTTPS检测
    • 
+                    
  • tcp: TCP端口检测
    • 
+                    
  • ping: PING检测
    • 
+
-
- -
-

状态码说明

-
    -
  • UP: 服务正常运行
    • -
  • DOWN: 服务不可用
    • -
  • UNKNOWN: 服务状态未知
    • -
-
- -
-

检测类型说明

-
    -
  • http: HTTP检测
    • -
  • https: HTTPS检测
    • -
  • tcp: TCP端口检测
    • -
  • ping: PING检测
    • -
-
-
-{% endblock %} \ No newline at end of file + + + + + + \ No newline at end of file