mubangizi/triangle-checker

Triangle Checker 镜像文档

镜像概述和主要用途

Triangle Checker是一个基于Node.js构建的应用程序，核心功能是根据输入的三角形边长参数判断并返回三角形类型（如等边、等腰、不等边或非三角形）。该应用提供API接口，适用于开发测试或作为微服务组件集成。

核心功能和特性

• 基于Node.js开发，轻量高效
• 提供POST接口/triangle，接收边长参数并返回三角形类型判断结果
• 内置API文档，可通过<server-url>/api-docs访问
• 支持单元测试，确保功能准确性
• 默认运行在50000端口，无需额外入口命令

API路由说明

使用场景和适用范围

• 开发环境中测试三角形类型判断逻辑
• 作为微服务为其他应用提供三角形类型判断功能
• 学习Node.js API开发和测试的示例应用

使用方法和配置说明

项目设置步骤

1. 克隆仓库

bash
git clone https://github.com/Mubangizi/triangle-checker.git

注意：若master分支非最新版本，可切换至develop分支（项目默认基础分支）：

bash
git checkout develop

2. 安装依赖

• 安装npm包管理器：访问npm官方下载页面获取对应操作系统的安装指南
• 导航至项目根目录，执行以下命令安装依赖：

  bash
  npm install
  

3. 启动应用

bash
npm start

应用将在50000端口启动。

4. 运行测试

bash
npm test

执行单元测试验证功能正确性。

5. 访问API文档

启动应用后，在浏览器中访问：

<server-url>/api-docs

查看API详细使用说明。

Docker部署示例

假设镜像名称为triangle-checker，运行命令如下：

bash
docker run -d -p 50000:50000 --name triangle-checker-app triangle-checker

• 参数说明：
  • -d：后台运行容器
  • -p 50000:50000：端口映射（主机端口:容器端口）
  • --name：指定容器名称

部署后可通过http://localhost:50000/triangle调用接口，通过http://localhost:50000/api-docs查看文档。