tykio/portal

Tyk Developer Portal 镜像文档

镜像概述

Tyk Developer Portal是Tyk API管理平台的核心组件，专为API提供者设计的开发者自助服务门户。该镜像提供完整的API文档管理、开发者账户管理、访问权限控制等功能，支持与Tyk Gateway深度集成，帮助组织降低开发者接入门槛，高效管理API生态系统。

核心功能与特性

1. API文档管理

• 支持OpenAPI 2.0/3.0规范，自动生成交互式API文档
• 提供API版本控制与历史文档管理
• 内置API测试控制台，支持在线调试API端点

2. 开发者自助服务

• 开发者账户注册、登录与个人资料管理
• 自助式API访问申请流程，支持自定义审批节点
• API访问凭证（API Key）生成、轮换与吊销管理

3. 权限与访问控制

• 基于角色的访问控制（RBAC）
• 精细化API产品与访问范围管理
• 申请状态实时跟踪与邮件通知

4. 品牌化与定制能力

• 支持自定义域名、Logo、主题色等品牌元素
• 可定制页面布局与内容模块
• 多语言界面支持（含中文、英文、日文等）

5. 集成与扩展

• 与Tyk Gateway/ Dashboard实时同步配置
• 支持LDAP/SAML/OAuth2.0第三方身份认证
• Webhook集成支持，对接外部系统（CRM/工单系统）

使用场景与适用范围

典型使用场景

• 企业API门户：向合作伙伴或内部团队提供标准化API服务入口
• 开发者生态建设：构建开放API生态，吸引第三方开发者集成
• API产品化运营：将API作为产品管理，支持订阅与访问控制
• 内部服务治理：统一管理企业内部微服务API文档与访问权限

适用范围

• 中大型企业IT部门
• API服务提供商
• 云服务厂商
• 微服务架构团队
• 需要构建开发者社区的组织

使用方法与配置说明

前提条件

• Docker Engine 19.03+
• 已部署Tyk Gateway（v3.0+）
• PostgreSQL 11+或MongoDB 4.2+数据库

基础部署（Docker Run）

bash
docker run -d \
  --name tyk-portal \
  -p 3000:3000 \
  -e TYK_PORTAL_DATABASE_TYPE=postgres \
  -e TYK_PORTAL_DATABASE_CONNECTION_STRING="host=postgres port=5432 dbname=tyk_portal user=portal_user password=portal_pass sslmode=disable" \
  -e TYK_GATEWAY_URL="http://tyk-gateway:8080" \
  -e TYK_PORTAL_ADMIN_EMAIL="admin@example.com" \
  -e TYK_PORTAL_ADMIN_PASSWORD="secure_password" \
  tykio/tyk-portal:latest

Docker Compose部署

yaml
version: '3.8'

services:
  tyk-portal:
    image: tykio/tyk-portal:latest
    container_name: tyk-portal
    ports:
      - "3000:3000"
    environment:
      - TYK_PORTAL_DATABASE_TYPE=postgres
      - TYK_PORTAL_DATABASE_CONNECTION_STRING=host=postgres port=5432 dbname=tyk_portal user=portal_user password=portal_pass sslmode=disable
      - TYK_GATEWAY_URL=http://tyk-gateway:8080
      - TYK_PORTAL_ADMIN_EMAIL=admin@example.com
      - TYK_PORTAL_ADMIN_PASSWORD=secure_password
      - TYK_PORTAL_SITE_NAME="ACME API Portal"
      - TYK_PORTAL_LOG_LEVEL=info
    depends_on:
      - postgres
      - tyk-gateway
    restart: unless-stopped

  postgres:
    image: postgres:13
    container_name: tyk-portal-db
    environment:
      - POSTGRES_DB=tyk_portal
      - POSTGRES_USER=portal_user
      - POSTGRES_PASSWORD=portal_pass
    volumes:
      - postgres-data:/var/lib/postgresql/data
    restart: unless-stopped

  tyk-gateway:
    image: tykio/tyk-gateway:latest
    container_name: tyk-gateway
    ports:
      - "8080:8080"
    environment:
      - TYK_GW_LISTENPORT=8080
      - TYK_GW_SECRET=your-secret-key
    restart: unless-stopped

volumes:
  postgres-data:

核心配置参数

环境变量配置

持久化配置

通过挂载卷持久化数据：

bash
docker run -d \
  --name tyk-portal \
  -p 3000:3000 \
  -v ./portal-data:/opt/tyk-portal/data \
  -v ./portal-config:/opt/tyk-portal/conf \
  -e TYK_PORTAL_DATABASE_TYPE=postgres \
  -e TYK_PORTAL_DATABASE_CONNECTION_STRING="host=postgres port=5432 dbname=tyk_portal user=portal_user password=portal_pass sslmode=disable" \
  tykio/tyk-portal:latest

访问与管理

部署完成后，通过 http://<宿主机IP>:3000 访问开发者门户，管理员可通过 /admin 路径登录后台（使用初始化的管理员账号）进行配置。

注意事项

• 生产环境建议配合Tyk Dashboard使用，统一管理API与门户配置
• 数据库需定期备份，避免数据丢失
• 高可用部署需配置负载均衡与数据库主从复制
• 敏感信息（如数据库密码）建议通过环境变量或secret管理，避免硬编码