安装与配置

1. 先决条件

在开始使用 SOLO 工作模式之前，请确保您的开发环境中已安装以下工具：

• Node.js: 版本 18.x 或更高。
• pnpm: 推荐使用 pnpm 进行依赖管理。
• Git: 用于版本控制。
• Docker: 用于运行容器化的服务和测试环境。
• Java Development Kit (JDK): 版本 17 或更高（如果使用 Java/Spring Boot）。
• Python: 版本 3.10 或更高（如果使用 Python/FastAPI）。

2. 安装 SOLO CLI

SOLO CLI 是与 SOLO 工作模式交互的核心工具，它简化了项目创建、代码生成、任务执行等操作。

目前，SOLO CLI 作为项目的一部分提供，通过 npm 脚本执行。

a. 克隆项目

首先，克隆包含 SOLO 工具的中央仓库：

git clone https://github.com/your-org/api-first-guide.git
cd api-first-guide

b. 安装依赖

使用 pnpm 安装项目所需的所有依赖：

pnpm install

这将安装包括 VitePress（用于文档）、TypeScript 和其他开发工具在内的所有依赖项。

3. 环境配置

a. 配置 OpenAPI Generator

SOLO 依赖 openapi-generator-cli 来生成代码。虽然它已作为开发依赖安装，但您可能需要根据项目需求配置特定的 Java 版本或内存设置。

您可以在 package.json 的脚本中查看其使用方式，例如：

"scripts": {
  "generate:server": "openapi-generator-cli generate -i openapi.yaml -g spring -o build/server"
}

b. 配置编辑器/IDE

为了获得最佳的开发体验，推荐安装以下 VS Code 插件：

• OpenAPI (Swagger) Editor: 提供对 openapi.yaml 文件的实时预览和校验。
• ESLint: 用于代码规范检查。
• Prettier: 用于代码格式化。
• Mermaid Markdown Syntax Highlighting: 用于在 Markdown 中高亮显示 Mermaid 图表。

4. 验证安装

安装完成后，您可以通过运行以下命令来验证环境是否配置正确：

a. 启动文档服务器

pnpm docs:dev

如果一切正常，您应该可以在浏览器中访问 http://localhost:5173 并看到本文档站点。

b. 运行项目生成器（示例）

尝试运行项目生成脚本，以确保核心功能正常工作：

node scripts/project-generator.js --type java-spring --name my-new-api

此命令将在 generated 目录下创建一个新的基于 Java Spring Boot 的项目结构。

5. 下一步

环境配置完成后，您可以继续学习 SOLO 快速开始 来创建您的第一个 API。