快速开始
本页帮助你在几分钟内跑起第一个 APIPIG AI 网关,并完成一次通过网关的模型调用。
环境要求
- 一台 Windows / macOS / Linux 机器(本地演示或服务器均可)
- 至少一个可用的上游模型 API Key(如 OpenAI、DeepSeek、Qwen 等)
第一步:下载二进制
前往 下载安装 页面,选择对应操作系统的发布包。以 Linux 为例:
# 解压后进入目录
cd /opt/apipig/
# 赋予执行权限并启动
chmod +x ./apipig
./apipig
第二步:初始化配置
浏览器访问 http://localhost:9527,服务器需要注意 开放 9527 端口,修改为您的服务器 ip 地址访问:
- 根据实际情况选择数据库填写相关配置内容
第三步:开始初始化
配置完成,点击 开始初始化 按照提示操作:
- 例如:提示
配置已写入,但未在预期时间内检测到服务自动恢复。请确认后台已重启后访问 http://localhost:9527检查服务端是否自动重启失败, 如果自行重启失败手动重启一下,并继续访问指定地址。
启动后
启动后,默认会在本地监听网关端口,并生成配置文件 config.yaml 与日志配置 logger.json。 请求会经过网关的 权限校验 → 路由命中 → 密钥注入 → 上游调用 → 审计留痕 全链路,业务侧无需感知上游细节。
Linux 辅助启动脚本
进入 /opt/apipig 目录并创建 boot.sh 脚本用于辅助 apipig 服务启动关闭。
- 启动
sh boot.sh start - 停止
sh boot.sh stop - 重启
sh boot.sh restart
#!/bin/bash
# 项目名称
PROJECT_NAME="apipig"
# 项目目录
PROJECT_DIR="/opt/apipig"
# 启动函数
start() {
echo "Starting $PROJECT_NAME..."
chmod 777 $PROJECT_DIR/$PROJECT_NAME
cd $PROJECT_DIR
nohup ./$PROJECT_NAME > logs/$PROJECT_NAME.out.log 2>&1 &
echo "$PROJECT_NAME started."
}
# 停止函数
stop() {
echo "Stopping $PROJECT_NAME..."
PID=$(ps -ef | grep $PROJECT_NAME | grep -v grep | awk '{print $2}')
if [ -z "$PID" ]; then
echo "$PROJECT_NAME is not running."
else
kill -9 $PID
echo "$PROJECT_NAME stopped."
fi
}
# 检查输入参数
case "$1" in
start)
start
;;
stop)
stop
;;
restart)
stop
sleep 2
start
;;
*)
echo "Usage: $0 {start|stop|restart}"
exit 1
;;
esac
exit 0
下一步
