部署指南

了解如何快速将您的应用部署到我们的平台

1

将代码上传到GitHub

将项目代码上传到 GitHub 或其他代码托管平台(如 Gitee、GitLab)。

上传步骤:

  1. 在 GitHub 创建一个新的仓库。
  2. 将本地项目代码提交并推送至该仓库。
  3. 确保主分支(通常为 mainmaster)包含完整可运行的代码。

如果您的仓库是私有的,请前往 GitHub 个人设置中创建一个访问 Token(Personal Access Token)。

在后续 创建 API 时,平台会需要您提供该 Token 以便访问代码。

上传代码至 GitHub 示例

✅ 成功上传后,您可以在浏览器中访问自己的仓库地址,确认代码可见。

2

自定义Dockerfile(可选)

接下来,您可以在项目根目录中编写一个 Dockerfile 文件,用于定义项目的构建与运行方式。

如果不熟悉 Docker,也可以跳过此步骤。平台会自动为常见框架(如 Node.js、Java、Python 等)生成 Dockerfile。

示例:springboot 项目

# ————————————————————————————————
# 第一阶段:编译 (Maven + JDK 8)
# ————————————————————————————————
FROM maven:3.8.7-eclipse-temurin-8 AS builder

# 声明构建参数
ARG SERVER_PORT

# 设置工作目录
WORKDIR /build

# 先复制 pom.xml 下载依赖,加快构建
COPY pom.xml .
RUN mvn dependency:go-offline -B

# 再复制源码
COPY src ./src

# 构建 jar 包(跳过测试可提高速度)
RUN mvn clean package -DskipTests

# ————————————————————————————————
# 第二阶段:运行 (JRE 8)
# ————————————————————————————————
FROM eclipse-temurin:8-jre AS runtime

# 构建参数,设置默认端口
ARG SERVER_PORT=8080

# 设置时区、工作目录和环境变量
ENV TZ=Asia/Shanghai \
    JAVA_OPTS="" \
    SERVER_PORT=${SERVER_PORT}

WORKDIR /app

# 从构建阶段复制 jar
COPY --from=builder /build/target/*.jar app.jar

# 暴露端口
EXPOSE ${SERVER_PORT}

# 启动命令使用环境变量
ENTRYPOINT ["sh", "-c", "java $JAVA_OPTS -jar /app/app.jar --server.port=${SERVER_PORT}"]

💡 如果项目能在本地通过 Docker 构建并运行,那么部署时也一定能顺利执行。

3

创建API-平台会自动部署

当代码上传完成后,就可以在平台中 创建 API 服务 了。平台会自动拉取您的代码并完成构建与部署。

创建步骤:

  1. 在控制台中点击「创建 API」。
  2. 填写必要的参数:
    • API 名称(例如:my-first-api
    • 仓库地址(GitHub/Gitee 等)
    • 分支名称(默认为 main
  3. 根据需要添加环境变量,例如数据库连接、API Key 等。
  4. 注意,环境变量的key一般都是大写的,如果是springboot项目,请将环境变量中的下划线_替换为点.,全部改为大写,例如:spring.datasource.url 替换为 SPRING_DATASOURCE_URL

  5. 点击「立即创建」,系统将自动开始部署。

如果您的代码仓库是私有的,请确保在创建 API 时提供正确的访问 Token。

首次部署可能需要数分钟,请耐心等待。部署完成后可在日志中查看状态。

API 创建页面示意图

🎉 部署成功后,平台会显示访问地址,您即可通过浏览器访问自己的应用!