添加 API.md
This commit is contained in:
parent
148d34d793
commit
d8aa6e3db3
26
API.md
Normal file
26
API.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
聊天服务器API文档
|
||||||
|
1. 服务器概述
|
||||||
|
服务类型: 混合服务(HTTP + Socket)
|
||||||
|
HTTP端口: 5001 (Flask)
|
||||||
|
Socket端口: 8888
|
||||||
|
数据库: SQLite (usr.db)
|
||||||
|
2. HTTP API接口
|
||||||
|
2.1 用户注册
|
||||||
|
端点: POST /api/register
|
||||||
|
请求格式:
|
||||||
|
json
|
||||||
|
Copy Code
|
||||||
|
{
|
||||||
|
"username": "string",
|
||||||
|
"password": "string"
|
||||||
|
}
|
||||||
|
成功响应:
|
||||||
|
json
|
||||||
|
Copy Code
|
||||||
|
{
|
||||||
|
"success": true,
|
||||||
|
"message": "User registered successfully"
|
||||||
|
}
|
||||||
|
错误响应:
|
||||||
|
403: 用户名已存在
|
||||||
|
500: 服务器内部错误
|
Loading…
x
Reference in New Issue
Block a user