Yaade - 一个 API 开发环境

Yaade 是一个开源、自托管、协作的 API 开发环境。

🤔为什么要开发 Yaade？

我一直在寻找一个自托管的 Postman 替代方案，以便可以轻松地在队友之间共享 API 集合。尽管存在像Hoppscotch这样的流行解决方案，但他们的自托管应用程序不附带身份验证，而是依赖 Firebase 来实现持久性。Yaade 是从头开始开发的，考虑到自托管和安全性。这意味着 API 请求中的敏感信息可以安全地存储在您自己的服务器上！

🌟特征

1. 自托管：数据永远不会离开您自己的服务器
2. 多用户：管理用户及其权限
3. 持久性：即使跨容器或服务器重新启动
4. 轻松的单文件数据导入/导出
5. 请求在您的机器上执行，因此您可以调用 localhost 以及远程服务器
6. 最重要的是：暗模式默认

⚡安装

要获得 Yaade 的最佳体验，请在您的服务器上运行 docker 容器并在本地计算机上安装浏览器扩展。

1.🐋Dokcer

docker volume create yaade
docker run -d --restart=always -p 9339:9339 -e YAADE_ADMIN_USERNAME=admin -v yaade:/app/data --name yaade esperotech/yaade:latest

默认密码是 password. 登录后转到⚙️> 帐户并更改密码。

2.🔧Extension

Yaade 使用浏览器扩展作为代理来启用 CORS 请求。使用您的浏览器扩展商店安装扩展。目前只有一个 chrome 扩展可用。你可以在这里找到它。然后打开它并输入您的服务器 URL，例如。https://yaade.example.com/. 从那时起，来自您的 Yaade 浏览器选项卡的所有请求都将通过扩展代理。

⬆️升级

要使用新版本升级 docker 容器，首先停止正在运行的容器，拉取最新版本并使用旧卷启动一个新容器。

docker rm -f yaade
docker pull esperotech/yaade:latest
docker run -d --restart=always -p 9339:9339 -e YAADE_ADMIN_USERNAME=admin -v yaade:/app/data --name yaade esperotech/yaade:latest

💾技术

1. 使用 TypeScript、React 和 Vite 构建的 SPA。
2. 使用 Kotlin 构建的后端。
3. H2 基于文件的数据库。
4. 带有纯 JavaScript 的浏览器扩展。

🖥️本地开发

1. 安装所需的依赖项

   • Java 11
   • Node>= 16
   • Kotlin

2. 克隆存储库

3. 安装项目特定的依赖项

cd scripts/
chmod +x install.sh
./install.sh

4. 使用您选择的 IDE 在端口 9339 上启动服务器（我使用 IntelliJ IDEA）
   • 也可以直接使用jar文件运行 $ java -jar server/build/libs/yaade-server-1.0-SNAPSHOT
   • 请注意，您必须设置环境变量 YAADE_ADMIN_USERNAME才能运行
5. 在端口 9338 上启动 vite 开发服务器

cd client/
npm run dev

6. 在端口 9337 上启动 dev-proxy

cd dev-proxy/
node index.js

7. 现在打开浏览器并访问http://localhost:9337

🔨建造

cd scripts/
chmod +x build.sh
./build.sh

截图

🌙黑暗模式

☀️灯光模式

🤝 我该如何贡献？

非常欢迎您的贡献！首先打开一个关于您想要贡献的主题的问题，例如。添加新功能、错误修复或重构。然后我们将讨论更多细节。最终，我将审查您的 Pull Request 并合并/发布它。