跳到主要内容
版本:3.10.x

启动本地开发者门户

使用 API7 网关 Docker Compose 安装包启动一个用于评估的本地开发者门户。该安装包会创建门户实例、门户令牌、前端配置和数据库,然后启动前端。

警告

此工作流仅用于本地评估。前端通过明文 HTTP 提供服务,因此开发者凭证和会话 Cookie 会以明文传输。向其他用户开放门户前,请将其置于 HTTPS 反向代理之后,并将 PORTAL_PUBLIC_URL 设置为 HTTPS URL。对于 Kubernetes、外部数据库、自定义前端部署或生产环境,请按照部署开发者门户中的说明操作。

前置条件​

  • 使用快速开始或使用 Docker Compose 部署中的快速安装方式安装 API7 网关。
  • 确认生成或解压的 api7-ee 目录中包含 portal.sh。如果该文件不存在,则无法使用安装包工作流;请按照部署开发者门户中的手动步骤操作。
  • 启动 API7 网关,并激活包含 API7 Portal 特性的许可证。
  • 准备好 API7 控制台管理员的凭证。

启动开发者门户​

在 api7-ee 目录中运行命令。如果 Shell 当前位于其父目录,请先运行 cd api7-ee。然后使用当前控制台凭证启动开发者门户:

ADMIN_USER=admin ADMIN_PASSWORD='<dashboard-password>' ./portal.sh start

如果控制台仍使用默认的 admin / admin 凭证,则无需设置 ADMIN_USER 和 ADMIN_PASSWORD,直接运行 ./portal.sh start 即可。

该脚本会执行以下操作:

  • 创建或复用门户实例及其门户令牌。
  • 将前端配置写入 developer_portal_fe_conf/config.yaml。
  • 在安装包自带的 PostgreSQL 实例中创建前端数据库。
  • 默认在 3001 端口启动前端。

启动完成后,脚本会输出开发者门户地址。

验证开发者门户​

  1. 打开 portal.sh 输出的地址。
  2. 选择 Sign Up 并创建开发者账户。
  3. 如果开发者门户提示创建组织,请创建一个组织。
  4. 打开 API Hub,确认页面可以正常加载。

新门户的 API Hub 初始为空,直到 API 提供商向其中发布 API 产品。按照管理 API 产品中的说明创建并发布一个 API 产品,然后刷新 API Hub,确认该产品已显示。

自定义安装包中的开发者门户​

启动开发者门户时可以设置以下环境变量:

变量默认值说明
ADMIN_USER、ADMIN_PASSWORDadmin、admin用于创建门户实例及其令牌的控制台凭证。
PORTAL_NAMEDeveloper Portal在 Provider Portal 中创建的门户实例名称。
PORTAL_PUBLIC_URLhttp://127.0.0.1:3001门户的公共 URL,同时会写入前端的 app.baseURL。
PORTAL_FE_PORT3001前端发布到宿主机的端口。

例如,按以下方式使用另一个本地端口:

ADMIN_USER=admin ADMIN_PASSWORD='<dashboard-password>' \
PORTAL_FE_PORT=3100 PORTAL_PUBLIC_URL="http://127.0.0.1:3100" \
./portal.sh start

再次运行该脚本时,会复用门户实例、门户令牌和身份认证密钥。重启后,现有开发者账户和会话仍然可用。

停止或移除开发者门户​

在 api7-ee 目录中运行生命周期命令:

./portal.sh stop
./portal.sh start
./portal.sh down

stop 会停止前端容器,down 会停止并移除该容器。生成的配置和数据库仍保留在安装包部署中;./run.sh start 会连同 API7 网关的其余组件再次启动前端。

后续步骤​