常见问题解决方案：EasyYapi 项目使用指南

常见问题解决方案：EasyYapi 项目使用指南

easy-yapi Generate API document to yapi 项目地址: https://gitcode.com/gh_mirrors/ea/easy-yapi

项目基础介绍

EasyYapi 是一个开源项目，用于生成API文档，并支持将文档导出到Yapi平台。该项目提供了对多种编程语言和框架的支持，包括Java、Kotlin、Scala、Web、Spring、Feign、Jaxrs (Quarkus 或 Jersey)、Dubbo等。主要编程语言为Kotlin和Java。

新手常见问题及解决步骤

问题一：项目依赖配置

问题描述： 新手在使用EasyYapi时，可能会遇到依赖配置错误，导致项目无法正常运行。

解决步骤：

1. 确保你的IDE（IntelliJ IDEA Ultimate 或 Community版本2021.2.1或更高）和JDK（版本11或更高）已经安装正确。
2. 检查项目中的build.gradle.kts文件，确保所有依赖项都已正确配置。
3. 运行/gradlew dependencies命令，检查依赖是否成功解析，没有错误。

问题二：插件安装失败

问题描述： 在尝试安装EasyYapi插件时，可能会遇到安装失败的错误。

解决步骤：

1. 确保你的IDE版本与插件兼容。
2. 从IDE的插件市场搜索“EasyYapi”，然后按照提示进行安装。
3. 如果安装失败，尝试手动下载插件的.jar文件，然后在IDE中手动安装。
4. 检查IDE的插件安装日志，找到错误原因，并根据错误信息进行相应的调整。

问题三：API文档生成失败

问题描述： 新手尝试生成API文档时，可能会遇到生成失败的问题。

解决步骤：

1. 确保你的代码符合EasyYapi支持的框架和注解。
2. 检查easyapi.config文件，确保配置正确，例如API基础路径、版本信息等。
3. 运行/gradlew :idea-plugin:runIde命令，以运行一个带有EasyYapi插件的IDE实例，并检查是否有错误提示。
4. 如果生成文档失败，检查生成的日志文件，根据日志中的错误信息进行调试。

通过以上步骤，新手应该能够解决在使用EasyYapi项目时遇到的常见问题。如果在解决问题的过程中遇到任何困难，可以参考项目官方文档或向社区寻求帮助。

easy-yapi Generate API document to yapi 项目地址: https://gitcode.com/gh_mirrors/ea/easy-yapi