Zally 开源项目安装与使用指南

Zally 开源项目安装与使用指南

zallyA minimalistic, simple-to-use API linter项目地址:https://gitcode.com/gh_mirrors/za/zally

目录结构概览

在克隆或下载了 Zally 的源代码之后, 您将看到以下主要目录:

根目录

根目录是整个项目的入口点. 它包含了三个关键子目录:

• server: 包含服务端代码.
• cli: 包含命令行界面工具代码.
• docs: 文档存放处.

server 目录

该目录包括用于运行服务端应用的所有代码及相关资源. 其中, 主要组成部分有:

• src/main/kotlin/: 存放Kotlin源码的目录.
• src/main/resources/: 放置资源文件的地方, 如配置文件.

cli 目录

这个部分负责管理CLI工具的构建过程. 主要文件夹包括:

• go.mod: Go语言的依赖管理和版本控制文件.

启动文件说明

server/gradle/wrapper/gradle-wrapper.jar

运行服务端应用

在server目录下执行下列命令可以构建并运行服务端应用:

./gradlew clean build
./gradlew bootRun > /dev/null &

cli/zally

构建并运行CLI工具

转到cli/zally目录:

cd cli/zally/

然后构建CLI工具:

go build ./cmd/zally-lint

最后运行你的CLI工具以检查API定义文件(例如Swagger YAML):

/path/to/go/bin/zally-lint /path/to/swagger/definition.yaml

配置文件解析

服务器端的配置由一个JSON文件提供, 默认情况下此文件路径位于server/src/main/resources/config.json.

在这个配置文件内, 您可以调整以下参数:

• port: 设置服务器监听的端口.
• authentication.enabled: 控制是否启用了身份验证功能.

以上就是您所需了解关于如何安装、启动以及定制Zally的基本知识. 确保按照步骤操作来充分利用这个简单的API linter提供的所有特性!

zallyA minimalistic, simple-to-use API linter项目地址:https://gitcode.com/gh_mirrors/za/zally