5个步骤搞定远程协助API部署：rustdesk-api-server从部署到精通

rustdesk-api-server是一款基于Go语言开发的远程协助API服务器，支持自建服务器部署，提供跨平台部署能力，让你轻松搭建专属的远程协助后端服务。通过它，你可以实现远程连接管理、账号创建、密码修改和主机地址簿维护等功能。

一、核心价值：为什么选择自建API服务器

自建rustdesk-api-server就像拥有了一个私人快递中转站，所有远程连接请求都通过你的服务器中转，既保证了数据安全，又能灵活控制访问权限。相比公共服务器，它能提供更稳定的连接质量和更个性化的功能定制。

二、环境速配：3步环境检测脚本

要确保你的服务器能顺利运行rustdesk-api-server，只需完成以下3步检测：

🔥 第一步：检查Go环境 运行命令：go version 预期结果：显示Go语言版本信息，证明Go环境已安装

🔥 第二步：检查GCC编译器 运行命令：gcc --version 预期结果：显示GCC版本信息，确保能编译依赖库

🔥 第三步：检查数据库 运行命令：mysql --version 或 sqlite3 --version 预期结果：显示MySQL或SQLite3版本信息，确认数据库可用

💡 小贴士：如果缺少以上任何一项，请先安装相应软件再继续

三、零门槛部署：5分钟完成服务器搭建

如何用3行命令完成项目部署

🔥 第一步：获取项目代码

git clone https://gitcode.com/gh_mirrors/rus/rustdesk-api-server
cd rustdesk-api-server

预期结果：项目代码下载到本地并进入项目目录

🔥 第二步：安装项目依赖

go mod download

预期结果：自动下载并安装所有依赖包

🔥 第三步：启动服务

go run main.go

预期结果：服务启动，显示类似"Server is running on :21114"的提示

四、实战指南：Postman可视化操作指南

如何用Postman管理用户账号

创建用户账号

1. 打开Postman，选择POST请求
2. 输入URL：http://127.0.0.1:21114/api/reg
3. 添加参数：username=test，password=test，auth_key=123456
4. 点击发送，预期结果：返回创建成功的JSON响应

修改用户密码

1. 选择POST请求
2. 输入URL：http://127.0.0.1:21114/api/set-pwd
3. 添加参数：username=test，password=newpassword，auth_key=123456
4. 点击发送，预期结果：返回修改成功的JSON响应

5分钟快速验证检查清单

• [ ] 服务启动后能访问 http://127.0.0.1:21114
• [ ] 成功创建测试用户
• [ ] 能正常修改用户密码
• [ ] 登录后可获取地址簿信息

五、避坑手册：常见问题解决方案

3个常见错误对比排查表

错误现象	可能原因	解决方案
启动时报数据库连接错误	数据库配置不正确	检查conf/app.conf中的数据库配置
21114端口被占用	端口已被其他程序使用	更换端口或关闭占用程序，命令：lsof -i:21114
API请求返回401	认证失败	检查JWT密钥配置或重新获取token

客户端配置指南

在RustDesk客户端中正确配置API服务器地址：

1. 打开RustDesk客户端设置
2. 找到"ID/中继服务器"设置项
3. 在"API服务器"输入框中填写：你的服务器IP:21114
4. 点击"确认"保存设置

💡 小贴士：Android客户端配置时不需要添加"http://"前缀

通过以上步骤，你已经掌握了rustdesk-api-server的部署和基本使用方法。这个自建的远程协助API服务器将为你的远程连接提供安全、稳定的支持，无论是个人使用还是企业部署，都能满足你的需求。记得定期备份数据库，以防止数据丢失。如果遇到其他问题，可以查看项目的README.md文件获取更多帮助。