Yaak API 客户端使用教程

Yaak API 客户端使用教程

yaak The most intuitive desktop API client. Organize and execute REST, GraphQL, WebSockets, Server Sent Events, and gRPC 🦬 项目地址: https://gitcode.com/gh_mirrors/ya/yaak

1. 项目目录结构及介绍

Yaak 是一个桌面 API 客户端，用于与 REST、GraphQL、Server Sent Events (SSE)、WebSocket 和 gRPC API 进行交互。项目目录结构如下：

yaak/
├── .github/
├── packages/
├── proto/
├── plugins/
├── scripts/
├── src-tauri/
├── src-web/
├── .eslintrc.cjs
├── .gitattributes
├── .gitignore
├── .nvmrc
├── .prettierrc.js
├── .prettierignore
├── DEVELOPMENT.md
├── LICENSE
├── README.md
├── package-lock.json
├── package.json
├── rustfmt.toml
├── tsconfig.json

主要目录说明：

• .github/: 存放 GitHub 相关的配置文件。
• packages/: 项目依赖的包文件。
• proto/: 定义了项目使用的协议文件。
• plugins/: 存放项目插件。
• scripts/: 包含项目构建和运行脚本。
• src-tauri/: Tauri 桌面应用的源代码目录。
• src-web/: Web 应用的源代码目录。
• .eslintrc.cjs: ESLint 配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件列表。
• .nvmrc: Node.js 版本管理器配置文件。
• .prettierrc.js: Prettier 代码格式化配置文件。
• .prettierignore: Prettier 忽略文件列表。

2. 项目的启动文件介绍

项目的启动文件主要位于 src-tauri/ 和 src-web/ 目录中。

src-tauri/ 启动文件：

• main.rs: Rust 编写的 Tauri 主程序入口文件。
• tauri.conf.json: Tauri 配置文件，定义了应用的基本信息、构建配置等。

src-web/ 启动文件：

• index.html: Web 应用的入口 HTML 文件。
• main.ts: TypeScript 编写的 Web 应用主程序入口文件。

3. 项目的配置文件介绍

项目的配置文件主要用于定义项目的基本设置和运行参数。

package.json:

项目的主配置文件，定义了项目的名称、版本、描述、依赖、脚本等。

{
  "name": "yaak",
  "version": "1.0.0",
  "description": "A desktop API client for interacting with REST, GraphQL, SSE, WebSocket, and gRPC APIs.",
  "scripts": {
    "start": "tauri run"
  },
  "dependencies": {
    // ...
  }
}

tauri.conf.json:

Tauri 配置文件，定义了应用的基本信息、窗口设置、权限请求等。

{
  "tauri": {
    "build": {
      "distDir": "dist",
      "devPath": "src-tauri/web",
      "beforeBuildCommand": "yarn build"
    },
    "recipes": [
      {
        "name": "tauri-api",
        "version": "1.0.0"
      }
    ]
  }
}

通过上述配置，用户可以更好地理解 Yaak API 客户端的目录结构、启动方式以及配置方法，从而顺利进行开发和部署。

yaak The most intuitive desktop API client. Organize and execute REST, GraphQL, WebSockets, Server Sent Events, and gRPC 🦬 项目地址: https://gitcode.com/gh_mirrors/ya/yaak