adamdeguire/console-api

Console API Docker镜像文档

镜像概述

本镜像提供面向开发者的社交应用Console的RESTful API服务，作为Console应用的后端接口层，支持开发者社交相关的各类功能调用，为前端应用或第三方服务提供标准化的数据交互接口。

核心功能和特性

• RESTful架构：遵循REST设计规范，提供标准化的API端点
• 开发者社交功能：支持用户注册、认证、关注、消息互动等社交功能
• 接口标准化：统一的请求/响应格式，便于前端集成和第三方服务对接
• 可扩展性：模块化设计，支持功能扩展和定制化开发

使用场景和适用范围

• 搭建开发者社区平台的后端服务
• 集成到开发者工具或IDE中提供社交功能
• 构建团队内部开发者协作与交流系统
• 作为第三方服务为其他应用提供开发者社交能力

使用方法和配置说明

基本使用

通过以下命令启动API服务：

bash
docker run -d -p 8080:8080 --name console-api docker.xuanyuan.run/api/console:latest

环境变量配置

完整启动示例

bash
docker run -d \
  -p 8080:8080 \
  --name console-api \
  -e DATABASE_URL="postgresql://user:password@db-host:5432/console" \
  -e JWT_SECRET="your-secure-jwt-secret" \
  -e CORS_ALLOWED_ORIGINS="https://console-app.example.com" \
  docker.xuanyuan.run/api/console:latest

Docker Compose配置示例

yaml
version: '3'
services:
  api:
    image: docker.xuanyuan.run/api/console:latest
    ports:
      - "8080:8080"
    environment:
      - DATABASE_URL=postgresql://user:password@db:5432/console
      - JWT_SECRET=your-secure-jwt-secret
      - LOG_LEVEL=debug
    depends_on:
      - db
  db:
    image: docker.xuanyuan.run/postgres:14
    environment:
      - POSTGRES_USER=user
      - POSTGRES_PASSWORD=password
      - POSTGRES_DB=console
    volumes:
      - postgres-data:/var/lib/postgresql/data

volumes:
  postgres-data:

健康检查

服务启动后，可通过访问 http://localhost:8080/health 端点检查服务状态，返回 {"status":"ok"} 表示服务正常运行。