vovochkastelmashchuk/mixdrinks

mixdrinks.org 后端服务

镜像概述和主要用途

该镜像为 mixdrinks.org 的后端服务，主要用于提供鸡尾酒制作相关的REST API，支持获取鸡尾酒、配方、食材和工具等数据，并提供按标签、食材、工具的筛选功能。

核心功能和特性

• 提供REST API接口，包含以下数据类型：
  • 鸡尾酒（Cocktails）
  • 食材（Goods）
  • 工具（Tools）
  • 标签（Tags）
• 支持按标签、食材、工具进行数据筛选

使用场景和适用范围

适用于需要集成鸡尾酒相关数据的应用或服务，如鸡尾酒制作指南、酒吧管理系统、鸡尾酒推荐应用等，可通过API获取标准化的鸡尾酒数据。

使用方法和配置说明

API文档

完整的REST API文档可参考：https://mixdrinks.github.io/docs/api

镜像标签

镜像提供以下标签，用于不同环境和版本控制：

• latest：生产环境版本
• pr-{{pull_request_number}}：拉取请求版本，例如 pr-1
• sha-{{commit_short_sha}}：提交SHA版本，例如 sha-1234567
• {{branch_name}}：分支最新提交版本，例如 main（主分支最新提交）

环境变量配置

该服务依赖PostgreSQL数据库，需配置以下环境变量：

• DB_URL：数据库连接URL，若数据库需要SSL，则需包含 sslmode=require
• DB_USER：数据库用户名，需对所有数据库有读权限
• DB_PASSWORD：数据库密码

部署示例

Docker Run 命令

bash
docker run -d \
  -e DB_URL="postgresql://user:password@postgres-host:5432/mixdrinks?sslmode=require" \
  -e DB_USER="user" \
  -e DB_PASSWORD="password" \
  --name mixdrinks-backend \
  docker.xuanyuan.run/mixdrinks/backend:latest

Docker Compose 配置

yaml
version: '3'
services:
  backend:
    image: docker.xuanyuan.run/mixdrinks/backend:latest
    environment:
      - DB_URL=postgresql://user:password@postgres:5432/mixdrinks?sslmode=require
      - DB_USER=user
      - DB_PASSWORD=password
    depends_on:
      - postgres
  postgres:
    image: docker.xuanyuan.run/postgres:14
    environment:
      - POSTGRES_USER=user
      - POSTGRES_PASSWORD=password
      - POSTGRES_DB=mixdrinks
    volumes:
      - postgres-data:/var/lib/postgresql/data

volumes:
  postgres-data:

问题反馈

如发现问题或需提交改进建议，请通过项目的issues标签提交issue。如需提交修复PR，请引用已创建的issue。

更多信息请参考：https://mixdrinks.github.io/docs/backend/