andesnqn/api

ANDES API 镜像文档

!https://github.com/andes/andes.github.io/raw/master/images/logo.png

镜像概述

ANDES API镜像用于部署ANDES系统的API服务，提供系统所需的API接口功能。该镜像支持Docker容器化部署，可简化环境配置，适用于生产和开发环境，便于快速启动和管理ANDES API服务。

核心功能和特性

• API接口服务：提供ANDES系统所需的API接口，支持系统核心功能调用
• 容器化部署：基于Docker容器化技术，简化部署流程，确保环境一致性
• 开发环境支持：支持目录挂载，实现代码实时更新，便于开发调试
• 灵活的依赖管理：可在容器内执行命令，方便安装和更新依赖包

使用场景和适用范围

• ANDES系统的API服务部署
• 开发环境中API服务的测试与调试
• 需要快速启动API服务的场景
• 对环境一致性有要求的部署场景

使用方法和配置说明

Docker镜像构建

通过以下命令构建ANDES API镜像：

bash
docker build -t andesnqn/api .

运行容器（生产环境）

使用以下命令启动容器，运行ANDES API服务（默认映射端口3002）：

bash
docker run -p 3002:3002 --rm --name andes_api andesnqn/api

开发环境运行容器

开发环境中，可通过目录挂载实现代码实时更新，命令如下：

bash
docker run -v ${pwd}:/usr/src/api -p 3002:3002 --rm --name andes_api andesnqn/api

容器管理命令

停止容器

bash
docker stop andes_api

在容器内执行命令

如需在运行中的容器内执行命令（如安装依赖），可使用：

bash
docker exec andes_api npm install