mediathekview/zapp-backend

zapp-backend Docker镜像

镜像概述和主要用途

zapp-backend是一个基于node.js的服务器应用，用于从德国公共广播服务获取当前节目信息（包括开始/结束时间、标题、描述等），并以JSON格式提供数据。该Docker镜像封装了此应用，方便快速部署和运行，主要为Android应用https://github.com/cemrich/zapp%E6%8F%90%E4%BE%9B%E8%8A%82%E7%9B%AE%E4%BF%A1%E6%81%AF%E6%94%AF%E6%8C%81%E3%80%82

核心功能和特性

核心功能

• 从多个德国公共广播服务获取节目信息
• 提供节目详情：开始时间、结束时间、标题、描述等元数据
• 以JSON格式返回数据，便于应用集成和解析

主要特性

• 基于node.js开发，轻量级且资源占用低
• 支持通过环境变量配置服务端口
• 提供标准化API端点，易于访问不同广播服务的节目数据
• 可通过Docker容器化部署，简化环境配置和版本管理

使用场景和适用范围

适用场景

• 为Android应用Zapp提供后端节目信息服务
• 开发需要获取德国公共广播节目数据的应用或服务
• 搭建本地或服务器端节目信息查询服务

适用范围

• 需要访问德国公共广播节目信息的开发者
• Zapp应用的服务端部署和运维
• Kubernetes集群中的微服务集成

详细使用方法和配置说明

Docker部署

基本运行命令

使用以下命令启动zapp-backend容器，将容器内部端口映射到主机端口：

bash
docker run --name zapp-backend -p 80:3000 mediathekview/zapp-backend

参数说明：

• --name zapp-backend：指定容器名称为zapp-backend
• -p 80:3000：端口映射，将主机的80端口映射到容器的3000端口（容器内默认端口为3000）
• mediathekview/zapp-backend：Docker镜像名称

Kubernetes部署

以下是在Kubernetes集群中部署zapp-backend的完整配置示例，包含命名空间、服务、部署和入口资源定义：

yaml
# 创建命名空间
apiVersion: v1
kind: Namespace
metadata:
  name: mediathekview
---
# 创建服务（Service）
apiVersion: v1
kind: Service
metadata:
  name: zapp-backend
  namespace: mediathekview
spec:
  ports:
    - name: http
      protocol: TCP
      port: 3000  # 服务暴露端口
  selector:
    app: zapp-backend  # 匹配标签为app: zapp-backend的Pod
---
# 创建部署（Deployment）
kind: Deployment
apiVersion: apps/v1
metadata:
  namespace: mediathekview
  name: zapp-backend
  labels:
    app: zapp-backend
spec:
  replicas: 1  # 运行的Pod副本数
  selector:
    matchLabels:
      app: zapp-backend
  template:
    metadata:
      labels:
        app: zapp-backend
    spec:
      containers:
        - name: zapp-backend
          image: mediathekview/zapp-backend  # 使用的Docker镜像
          ports:
            - name: web
              containerPort: 3000  # 容器内部服务端口
---
# 创建入口（Ingress）
kind: Ingress
apiVersion: extensions/v1beta1
metadata:
  name: zapp-backend-ingress
  namespace: mediathekview
spec:
  rules:
    - host: api.zapp.mediathekview.de  # 访问域名
      http:
        paths:
          - path: /
            backend:
              serviceName: zapp-backend  # 关联的服务名称
              servicePort: 3000  # 服务端口

本地运行与测试（补充说明）

本地开发环境运行步骤（非容器方式）

1. 确保已安装node.js运行环境
2. 通过Git克隆项目代码库
3. 在项目目录中执行npm install安装依赖包
4. 设置端口环境变量：
   • Linux/macOS: PORT=3000
   • Windows: SET PORT=3000
5. 执行npm start启动服务
6. 访问http://localhost:3000/v1/shows/das_erste（将3000替换为实际设置的端口）获取ARD的节目信息

测试命令

• 执行npm test：运行代码检查和基本功能测试
• 执行npm lint：通过jshint检查代码风格规范性