escolalms/api

Wellms Laravel REST API 镜像文档

镜像概述

Wellms Laravel REST API 镜像是一个预配置的Docker镜像，基于Laravel框架构建，专为快速部署和运行RESTful API服务设计。该镜像集成了Laravel生态系统的核心组件，提供标准化的API开发环境，简化后端服务的搭建流程，帮助开发者专注于业务逻辑实现而非环境配置。

核心功能与特性

• Laravel框架支持：内置最新稳定版Laravel框架，支持路由、控制器、模型、迁移等核心功能
• RESTful API规范：遵循RESTful设计原则，提供标准HTTP方法（GET/POST/PUT/DELETE）支持
• 灵活的配置管理：通过环境变量实现动态配置，支持多环境（开发/测试/生产）切换
• 数据库集成：兼容MySQL、PostgreSQL等主流数据库，内置数据库迁移和种子数据支持
• 中间件支持：包含认证、授权、CORS、请求验证等常用中间件，保障API安全与合规
• 性能优化：集成缓存机制（Redis/Memcached）、队列服务，提升API响应速度和并发处理能力
• 日志与监控：内置日志系统，支持日志输出到标准输出流，便于容器化环境日志收集

使用场景与适用范围

• 企业级Web应用后端：为管理系统、电商平台等提供稳定高效的API服务
• 移动应用后端：支持iOS/Android等移动应用的API数据交互需求
• SaaS平台接口：作为多租户SaaS系统的API网关，处理租户请求与数据隔离
• 快速原型开发：帮助开发者在短时间内搭建可运行的API服务原型，加速产品迭代
• 微服务架构：作为微服务架构中的API服务节点，与其他服务协同工作

使用方法与配置说明

基本使用

通过docker run命令快速启动服务：

bash
docker run -d \
  --name wellms-api \
  -p 8000:8000 \
  -e APP_ENV=production \
  -e APP_KEY=base64:your_generated_app_key \
  -e DB_CONNECTION=mysql \
  -e DB_HOST=mysql-host \
  -e DB_PORT=3306 \
  -e DB_DATABASE=wellms_db \
  -e DB_USERNAME=db_user \
  -e DB_PASSWORD=db_password \
  wellms/laravel-rest-api:latest

环境变量配置

镜像支持通过环境变量进行灵活配置，常用环境变量如下：

Docker Compose配置示例

推荐使用docker-compose.yml进行多容器部署（如API服务+数据库）：

yaml
version: '3.8'

services:
  api:
    image: wellms/laravel-rest-api:latest
    container_name: wellms-api
    restart: always
    ports:
      - "8000:8000"
    environment:
      - APP_ENV=production
      - APP_KEY=base64:your_generated_app_key_here
      - DB_CONNECTION=mysql
      - DB_HOST=mysql
      - DB_PORT=3306
      - DB_DATABASE=wellms
      - DB_USERNAME=wellms_user
      - DB_PASSWORD=secure_password
      - CACHE_DRIVER=redis
      - QUEUE_CONNECTION=redis
    depends_on:
      - mysql
      - redis

  mysql:
    image: mysql:8.0
    container_name: wellms-mysql
    restart: always
    environment:
      - MYSQL_ROOT_PASSWORD=root_password
      - MYSQL_DATABASE=wellms
      - MYSQL_USER=wellms_user
      - MYSQL_PASSWORD=secure_password
    volumes:
      - mysql-data:/var/lib/mysql

  redis:
    image: redis:alpine
    container_name: wellms-redis
    restart: always
    volumes:
      - redis-data:/data

volumes:
  mysql-data:
  redis-data:

启动命令：docker-compose up -d

数据持久化与日志

• 应用数据：通过挂载卷/var/www/html/storage实现上传文件、日志等数据持久化
• 日志收集：默认日志输出到/var/www/html/storage/logs目录，可通过挂载卷或配置LOG_CHANNEL=stdout将日志输出到容器标准输出流，便于Docker日志驱动收集

扩展与定制

如需自定义配置，可通过以下方式：

1. 挂载自定义.env文件：-v /path/to/your/.env:/var/www/html/.env
2. 构建自定义镜像：基于此镜像添加Dockerfile，安装额外依赖或修改配置
3. 使用docker exec进入容器临时调整：docker exec -it wellms-api bash

注意事项

• 首次启动需确保APP_KEY已正确生成（可通过docker exec wellms-api php artisan key:generate生成）
• 生产环境中建议启用HTTPS，可配合Nginx反向代理实现
• 定期备份数据库数据和应用配置，避免数据丢失
• 根据实际负载调整容器资源限制（如--memory、--cpus参数）