#yaml-config #open-api #generator #generate #found #api-client #directory

app thanix

yaml到Rust代码生成器,用于从yaml配置文件生成Rust代码,例如在openAPI中找到的。

4个版本

0.1.0 2024年1月17日
0.1.0-beta.42024年8月12日
0.1.0-beta.32024年4月29日
0.1.0-beta.12024年2月26日
0.1.0-alpha.9 2024年1月24日

数据库接口 中排名 206

Download history 152/week @ 2024-04-25 30/week @ 2024-05-02 1/week @ 2024-07-25 72/week @ 2024-08-08

每月下载 73

GPL-3.0 许可证

31KB
430 代码行

████████╗██╗  ██╗ █████╗ ███╗   ██╗██╗██╗  ██╗
╚══██╔══╝██║  ██║██╔══██╗████╗  ██║██║╚██╗██╔╝
   ██║   ███████║███████║██╔██╗ ██║██║ ╚███╔╝
   ██║   ██╔══██║██╔══██║██║╚██╗██║██║ ██╔██╗
   ██║   ██║  ██║██║  ██║██║ ╚████║██║██╔╝ ██╗
   ╚═╝   ╚═╝  ╚═╝╚═╝  ╚═╝╚═╝  ╚═══╝╚═╝╚═╝  ╚═╝

欢迎使用Thanix!

Thanix是一个实验性的命令行应用程序,使用Rust编写,用于从类似于openAPI架构的yaml模式文件生成Rust代码。

build result

安装

请注意,Thanix目前仅在Linux发行版上开发和运行。
未来可能会提供对其他操作系统的支持,但当前无法保证其工作。

从源代码构建

从源代码构建为您提供Thanix的最新更新和更改。但是,请注意,这些可能是不稳定的,因此建议下载标记版本。

此外,请确保您已安装 Rust编程语言和Cargo

要从源代码构建Thanix,您需要遵循以下步骤

  1. 下载源代码。为此,请在您的终端中运行此命令
git clone [email protected]:The-Nazara-Project/Thanix.git

这将创建一个名为 Thanix 的新目录,并移动到该目录。

  1. 直接运行应用程序

您现在可以使用 cargo run 命令运行Thanix。但是,这个过程可能需要更长的时间,并且可能感觉不太舒适。

不要忘记在执行此操作时向Thanix传递所需的CLI参数。

cargo run -- $PATH_TO_YOUR_YAML --output $PATH_TO_YOUR_OUTPUT

这可能看起来像这样

cargo run --  ./api_config.yaml --output thanix_client/

此步骤将生成您的 thanix_client

要查看下一步,请向下滚动到 使用部分

可选

  1. 使用 cargo install 安装Thanix。

您还可以将crate安装到您的系统上,这样您就始终可以使用它。为此,请在Thanix项目目录中运行此命令

cargo install --path .

这将安装Thanix到您的系统上,您可以通过在终端中简单地运行 thanix 来执行它。

使用Cargo安装Thanix

Thanix还发布在 crates.io

要安装它,只需运行

cargo install thanix

将Thanix安装为分发包(待定)

我们正在为各种Linux发行版构建软件包,首先是 openSUSE Tumbleweed

您可以使用以下步骤在openSUSE Tumbleweed上安装Thanix

  1. 添加仓库
sudo zypper ar https://download.opensuse.org/repositories/home:/ByteOtter:/nazara-project/openSUSE_Tumbleweed/home:ByteOtter:nazara-project.repo
8m
  1. 刷新仓库
sudo zypper ref
  1. 安装Thanix
sudo zypper install Thanix

Zypper现在应该会为您安装Thanix。

注意:仓库位置是临时的,一旦Thanix停止测试版,它将进行更改。如果您不想处理这个问题,我们建议您使用上述方法之一安装Thanix。感谢您的理解。

使用方法

您以适合您的方式安装Thanix后,可以通过传递以下两个必需的参数来使用它

thanix  $YOUR_API_YAML --output thanix_client/
  • $YOUR_API_YAML参数是指向您要使用的.yaml文件的路径。这通常是您想要为生成客户端的API模式文件。
  • --output参数是可选的,它指定Thanix输出应该放置的路径。如果省略,它将在您的当前工作目录中创建一个名为output的目录。

依赖关系

~5.5MB
~96K SLoC