mirror of
https://github.com/mountain-loop/yaak.git
synced 2026-04-11 03:26:58 +02:00
Merge remote-tracking branch 'origin/main'
This commit is contained in:
Gregory Schier
70
README.md
70
README.md
@@ -1,61 +1,66 @@
|
|||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://github.com/JamesIves/github-sponsors-readme-action">
|
<a href="https://github.com/JamesIves/github-sponsors-readme-action">
|
||||||
<img width="200px" src="https://github.com/mountain-loop/yaak/raw/main/src-tauri/icons/icon.png">
|
<img width="200px" src="https://github.com/mountain-loop/yaak/raw/main/src-tauri/icons/icon.png">
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
<!--<p align="center">
|
|
||||||
<a href="https://github.com/mountain-loop/yaak/actions/workflows/release.yml">
|
|
||||||
<img alt="GitHub Release" src="https://img.shields.io/github/v/release/mountain-loop/yaak?style=flat&color=fushia"></a>
|
|
||||||
<a href="https://github.com/sponsors/gschie" alt="Sponsors on GitHub">
|
|
||||||
<img src="https://img.shields.io/github/sponsors/gschier?style=flat&color=red" /></a>
|
|
||||||
<a href="https://yaak.app/discord">
|
|
||||||
<img alt="Discord" src="https://img.shields.io/discord/1387916086980251832?style=flat&label=Discord&color=blue"></a>
|
|
||||||
</p>-->
|
|
||||||
|
|
||||||
<h1 align="center">
|
<h1 align="center">
|
||||||
⭐ Yaak – Desktop API Client ⭐
|
💫 Yaak ➟ Desktop API Client 💫
|
||||||
</h1>
|
</h1>
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
A desktop API client for REST, GraphQL, SSE, WebSocket, and gRPC
|
A fast, privacy-first API client for REST, GraphQL, SSE, WebSocket, and gRPC – built with Tauri, Rust, and React.
|
||||||
APIs. It's built using Tauri, Rust, and React.
|
|
||||||
</p>
|
</p>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
Development is supported by community-purchased <a href="https://yaak.app/pricing">licenses</a>. You can also <a href="https://github.com/sponsors/gschier">become a sponsor</a> to have your avatar or company logo appear below. 💖
|
Development is funded by community-purchased <a href="https://yaak.app/pricing">licenses</a>. You can also <a href="https://github.com/sponsors/gschier">become a sponsor</a> to have your logo appear below. 💖
|
||||||
</p>
|
</p>
|
||||||
|
<br>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<!-- sponsors-premium --><a href="https://github.com/dmmulroy"><img src="https://github.com/dmmulroy.png" width="80px" alt="User avatar: dmmulroy" /></a> <a href="https://github.com/timcole"><img src="https://github.com/timcole.png" width="80px" alt="User avatar: timcole" /></a> <a href="https://github.com/MVST-Solutions"><img src="https://github.com/MVST-Solutions.png" width="80px" alt="User avatar: MVST-Solutions" /></a> <a href="https://github.com/dharsanb"><img src="https://github.com/dharsanb.png" width="80px" alt="User avatar: dharsanb" /></a> <a href="https://github.com/railwayapp"><img src="https://github.com/railwayapp.png" width="80px" alt="User avatar: railwayapp" /></a> <a href="https://github.com/caseyamcl"><img src="https://github.com/caseyamcl.png" width="80px" alt="User avatar: caseyamcl" /></a> <a href="https://github.com/terasaka2k"><img src="https://github.com/terasaka2k.png" width="80px" alt="User avatar: terasaka2k" /></a> <a href="https://github.com/andriyor"><img src="https://github.com/andriyor.png" width="80px" alt="User avatar: andriyor" /></a> <a href="https://github.com/"><img src="https://raw.githubusercontent.com/JamesIves/github-sponsors-readme-action/dev/.github/assets/placeholder.png" width="80px" alt="User avatar: " /></a> <!-- sponsors-premium -->
|
<!-- sponsors-premium --><a href="https://github.com/MVST-Solutions"><img src="https://github.com/MVST-Solutions.png" width="80px" alt="User avatar: MVST-Solutions" /></a> <a href="https://github.com/dharsanb"><img src="https://github.com/dharsanb.png" width="80px" alt="User avatar: dharsanb" /></a> <a href="https://github.com/railwayapp"><img src="https://github.com/railwayapp.png" width="80px" alt="User avatar: railwayapp" /></a> <a href="https://github.com/caseyamcl"><img src="https://github.com/caseyamcl.png" width="80px" alt="User avatar: caseyamcl" /></a> <a href="https://github.com/andriyor"><img src="https://github.com/andriyor.png" width="80px" alt="User avatar: andriyor" /></a> <a href="https://github.com/"><img src="https://raw.githubusercontent.com/JamesIves/github-sponsors-readme-action/dev/.github/assets/placeholder.png" width="80px" alt="User avatar: " /></a> <!-- sponsors-premium -->
|
||||||
</p>
|
</p>
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<!-- sponsors-base --><a href="https://github.com/seanwash"><img src="https://github.com/seanwash.png" width="50px" alt="User avatar: seanwash" /></a> <a href="https://github.com/jerath"><img src="https://github.com/jerath.png" width="50px" alt="User avatar: jerath" /></a> <a href="https://github.com/itsa-sh"><img src="https://github.com/itsa-sh.png" width="50px" alt="User avatar: itsa-sh" /></a> <a href="https://github.com/VLZH"><img src="https://github.com/VLZH.png" width="50px" alt="User avatar: VLZH" /></a> <!-- sponsors-base -->
|
<!-- sponsors-base --><a href="https://github.com/seanwash"><img src="https://github.com/seanwash.png" width="50px" alt="User avatar: seanwash" /></a> <a href="https://github.com/jerath"><img src="https://github.com/jerath.png" width="50px" alt="User avatar: jerath" /></a> <a href="https://github.com/itsa-sh"><img src="https://github.com/itsa-sh.png" width="50px" alt="User avatar: itsa-sh" /></a> <a href="https://github.com/dmmulroy"><img src="https://github.com/dmmulroy.png" width="50px" alt="User avatar: dmmulroy" /></a> <a href="https://github.com/timcole"><img src="https://github.com/timcole.png" width="50px" alt="User avatar: timcole" /></a> <a href="https://github.com/VLZH"><img src="https://github.com/VLZH.png" width="50px" alt="User avatar: VLZH" /></a> <a href="https://github.com/terasaka2k"><img src="https://github.com/terasaka2k.png" width="50px" alt="User avatar: terasaka2k" /></a> <!-- sponsors-base -->
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
Yaak is an offline-first API client designed to stay out of your way while giving you everything you need when you need it.
|
||||||
|
Built with [Tauri](https://tauri.app), Rust, and React, it’s fast, lightweight, and private. No telemetry, no VC funding, and no cloud lock-in.
|
||||||
|
|
||||||
|
|
||||||
|
### 🌐 Work with any API
|
||||||
|
|
||||||
|
- Import collections from Postman, Insomnia, OpenAPI, Swagger, or Curl.
|
||||||
|
- Send requests via REST, GraphQL, gRPC, WebSocket, or Server-Sent Events.
|
||||||
|
- Filter and inspect responses with JSONPath or XPath.
|
||||||
|
|
||||||
|
### 🔐 Stay secure
|
||||||
|
- Use OAuth 2.0, JWT, Basic Auth, or custom plugins for authentication.
|
||||||
|
- Secure sensitive values with end-to-end encryption.
|
||||||
|
- Store secrets in your OS keychain.
|
||||||
|
|
||||||
|
### ☁️ Organize & collaborate
|
||||||
|
- Group requests into workspaces and nested folders.
|
||||||
|
- Use environment variables to switch between dev, staging, and prod.
|
||||||
|
- Mirror workspaces to your filesystem for versioning in Git or syncing with Dropbox.
|
||||||
|
|
||||||
|
### 🧩 Extend & customize
|
||||||
|
- Insert dynamic values like UUIDs or timestamps with template tags.
|
||||||
|
- Pick from built-in themes or build your own.
|
||||||
|
- Create plugins to extend authentication, template tags, or the UI.
|
||||||
|
|
||||||
|
|
||||||
## Contribution Policy
|
## Contribution Policy
|
||||||
|
|
||||||
Yaak is open source, but only accepting contributions for bug fixes. To get started,
|
Yaak is open source, but only accepting contributions for bug fixes. To get started,
|
||||||
visit [`DEVELOPMENT.md`](DEVELOPMENT.md) for tips on setting up your environment.
|
visit [`DEVELOPMENT.md`](DEVELOPMENT.md) for tips on setting up your environment.
|
||||||
|
|
||||||
## Feature Overview
|
|
||||||
|
|
||||||
- 🪂 Import data from Postman, Insomnia, OpenAPI, Swagger, or Curl.<br/>
|
|
||||||
- 📤 Send requests via REST, GraphQL, Server Sent Events (SSE), WebSockets, or gRPC.<br/>
|
|
||||||
- 🔐 Automatically authorize requests with OAuth 2.0, JWT tokens, Basic Auth, and more.<br/>
|
|
||||||
- 🔎 Filter response bodies using JSONPath or XPath queries.<br/>
|
|
||||||
- ⛓️ Chain together multiple requests to dynamically reference values.<br/>
|
|
||||||
- 📂 Organize requests into workspaces and nested folders.<br/>
|
|
||||||
- 🧮 Use environment variables to easily switch between Prod and Dev.<br/>
|
|
||||||
- 🛡️ Secure arbitrary text values with end-to-end encryption<br/>
|
|
||||||
- 🏷️ Send dynamic values like UUIDs or timestamps using template tags.<br/>
|
|
||||||
- 🎨 Choose from many of the included themes, or make your own.<br/>
|
|
||||||
- 💽 Mirror workspace data to a directory for integration with Git or Dropbox.<br/>
|
|
||||||
- 📜 View response history for each request.<br/>
|
|
||||||
- 🔌 Create your own plugins for authentication, template tags, and more!<br/>
|
|
||||||
- 🛜 Configure a proxy to access firewall-blocked APIs
|
|
||||||
|
|
||||||
## Useful Resources
|
## Useful Resources
|
||||||
|
|
||||||
- [Feedback and Bug Reports](https://feedback.yaak.app)
|
- [Feedback and Bug Reports](https://feedback.yaak.app)
|
||||||
@@ -63,3 +68,4 @@ visit [`DEVELOPMENT.md`](DEVELOPMENT.md) for tips on setting up your environment
|
|||||||
- [Yaak vs Postman](https://yaak.app/alternatives/postman)
|
- [Yaak vs Postman](https://yaak.app/alternatives/postman)
|
||||||
- [Yaak vs Bruno](https://yaak.app/alternatives/bruno)
|
- [Yaak vs Bruno](https://yaak.app/alternatives/bruno)
|
||||||
- [Yaak vs Insomnia](https://yaak.app/alternatives/insomnia)
|
- [Yaak vs Insomnia](https://yaak.app/alternatives/insomnia)
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user