Easy-YApi 项目使用教程

Easy-YApi 项目使用教程

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

1. 项目的目录结构及介绍

Easy-YApi 项目的目录结构如下：

easy-yapi/
├── docs/
│   └── api_doc/
├── src/
│   ├── main/
│   │   ├── java/
│   │   └── resources/
│   └── test/
│       ├── java/
│       └── resources/
├── build.gradle
├── settings.gradle
└── README.md

目录结构介绍

• docs/: 存放项目文档，特别是 API 文档。
• src/main/java/: 存放主要的 Java 源代码。
• src/main/resources/: 存放主要的资源文件，如配置文件等。
• src/test/java/: 存放测试代码。
• src/test/resources/: 存放测试资源文件。
• build.gradle: Gradle 构建脚本。
• settings.gradle: Gradle 项目设置文件。
• README.md: 项目介绍和使用说明。

2. 项目的启动文件介绍

Easy-YApi 项目的启动文件主要是通过 Gradle 脚本来执行的。以下是一些常用的 Gradle 命令：

• 启动 IDEA 实例:

  ./gradlew :idea-plugin:runIde
  

  该命令会启动一个带有 Easy-YApi 插件的 IntelliJ IDEA 实例。

• 运行测试:

  ./gradlew clean test
  

  该命令会运行所有测试用例。

3. 项目的配置文件介绍

Easy-YApi 项目的配置文件主要位于 src/main/resources/ 目录下。以下是一些关键的配置文件：

• application.properties: 主要配置文件，包含项目的基本配置信息，如服务器地址、端口等。
• logback.xml: 日志配置文件，用于配置日志输出格式和存储位置。

application.properties 示例

server.address=http://localhost
server.port=8080
yapi.token=your_yapi_token

logback.xml 示例

<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="debug">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

通过这些配置文件，开发者可以灵活地调整项目的运行参数和日志输出方式。

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