Super-frpc/backend
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

docs(api): fix some abnormal response templete in API docs

Browse Source
This commit is contained in:
NanamiAdmin
2026-03-10 14:52:18 +08:00
parent f3fca7f07b
commit f2b07a7732
3 changed files with 25 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.gitignore
+1
View File
@@ -45,3 +45,4 @@ agent.md
super-frpc super-frpc
super-frpc.exe super-frpc.exe
*.db *.db
database.db
database.db
BIN
View File
Binary file not shown.
docs/api.md
+23 -21
View File
@@ -297,16 +297,18 @@ X-Timestamp: 1704067200000
"message": "User list retrieved successfully", "message": "User list retrieved successfully",
"data": [ "data": [
{ {
"userID": 1, "UserID": 1,
"username": "admin", "Username": "admin",
"type": "superuser", "Passwd": "",
"createdAt": "2024-01-01 12:00:00" "Type": "superuser",
"CreatedAt": "2024-01-01 12:00:00"
}, },
{ {
"userID": 2, "UserID": 2,
"username": "new_user", "Username": "new_user",
"type": "admin", "Passwd": "",
"createdAt": "2024-01-02 14:30:00" "Type": "admin",
"CreatedAt": "2024-01-02 14:30:00"
} }
] ]
} }
@@ -314,10 +316,10 @@ X-Timestamp: 1704067200000
| Field | Type | Description | | Field | Type | Description |
|-------|------|-------------| |-------|------|-------------|
| userID | int | User ID | | UserID | int | User ID |
| username | string | Username | | Username | string | Username |
| type | string | User type: superuser, admin, visitor | | Type | string | User type: superuser, admin, visitor |
| createdAt | string | User creation time (YYYY-MM-DD HH:MM:SS format) | | CreatedAt | string | User creation time (YYYY-MM-DD HH:MM:SS format) |
--- ---
@@ -347,15 +349,15 @@ X-Timestamp: 1704067200000
"data": [ "data": [
{ {
"ID": "session-5f4dcc3b5aa765d61d8327deb882cf99-1704067200000", "ID": "session-5f4dcc3b5aa765d61d8327deb882cf99-1704067200000",
"userID": 1, "UserID": 1,
"username": "admin", "Username": "admin",
"expireAt": "2024-01-01T01:00:00Z" "ExpireAt": "2024-01-01T01:00:00Z"
}, },
{ {
"ID": "session-7c6a180b36896a0a8c010710c0780347-1704067210000", "ID": "session-7c6a180b36896a0a8c010710c0780347-1704067210000",
"userID": 2, "UserID": 2,
"username": "new_user", "Username": "new_user",
"expireAt": "2024-01-01T01:00:10Z" "ExpireAt": "2024-01-01T01:00:10Z"
} }
] ]
} }
@@ -364,9 +366,9 @@ X-Timestamp: 1704067200000
| Field | Type | Description | | Field | Type | Description |
|-------|------|-------------| |-------|------|-------------|
| ID | string | Unique session ID | | ID | string | Unique session ID |
| userID | int | User ID | | UserID | int | User ID |
| username | string | Username | | Username | string | Username |
| expireAt | string | Session expiration time (ISO 8601 format) | | ExpireAt | string | Session expiration time (ISO 8601 format) |
--- ---