postcatlab / postcat

Postcat 是一个可扩展的 API 工具平台。集合基础的 API 管理和测试功能，并且可以通过插件简化你的 API 开发工作，让你可以更快更好地创建 API。An extensible API tool.

Postcat API 客户端（Client）

English | 简体中文

🛠️ 小更新，大改变：Postcat 正在重构中！ 🚀

嘿，Postcat 的朋友们！

只是想快速告诉大家，我们的项目现在正处在一次激动人心的重构旅程中。这并不意味着 Postcat 没有得到维护，恰恰相反，我们正在给它注入新的活力！

在这个阶段，可能会有些静悄悄的，但请相信，我们在幕后正忙得不可开交。我们致力于让 Postcat 变得更酷、更易用，只是需要一点时间来打磨和完善。

所以，请继续关注，不久的将来，你们会见到一个焕然一新的 Postcat。你的支持和耐心是我们最宝贵的动力！

敬请期待，更多精彩即将来临！

概述

Postcat 是一个强大的开源、免费的、跨平台（Windows、Mac、Linux、Browsers...）的 API 开发测试工具，支持 REST、Websocket 等协议（即将支持 GraphQL、gRPC、TCP、UDP），帮助你加速完成 API 开发和测试工作。它非常适合中小团队及个人使用。

我们在保证 Postcat 轻巧灵活的同时，还为它设计了一个强大的插件系统，让您可以一键使用插件来增强它的功能。

因此 Postcat 理论上是一个拥有无限可能的 API 产品，可以从Logo 中看到，我们也形象地为它加上了一件披风，代表它的无限可能。

免登录在线使用或下载

Postcat 现在已经支持 Windows、Mac、Linux等系统，你可以通过以下地址访问并下载。同时我们也提供了 Web 端，方便你在任何浏览器上使用。

https://postcat.com/

如果您试用之后觉得不错，请给我们的Postcat一个 Star 和 Fork~你的支持是我们不断改进产品的动力！

详细的文档

Postcat 文档

插件开发文档

功能特性和迭代计划（Roadmap）

• 🚀 多协议支持

-- 已实现：HTTP REST、Websocket

-- 即将实现：GraphQL、TCP、UDP、gRPC

• 📕 API 文档

• ✨ API 设计

• ⚡ API 测试

• 🎭 Mock

• 🙌 团队协作

• 🎈 文档分享

• 🗺 环境

• 🧶 全局变量

• 🧩 自定义主题风格

• 🌐 多语言支持：中文、English

了解更多具体迭代计划：Github Project
也欢迎给我们多多提需求~

💪 贡献者 💪

感谢你们让美好发生！

_{Power by contrib.rocks.}

Bug 和需求反馈

如果想要反馈 Bug、提供产品意见，可以创建一个 Github issue 联系我们，十分感谢！

如果您希望和 Postcat 团队近距离交流，讨论产品使用技巧以及了解更多产品最新进展，欢迎加入以下渠道。

• QQ群号码：981965807

• QQ群链接：加入Postcat 用户群

• 微信群：

开发 Postcat

运行代码

请确保你已经部署好所需的开发环境：

• Node.js >= 14.17.x

• yarn >= 1.22.x

我们在开发和构建时使用 yarn 作为包管理工具，强烈建议你也这么做，但如果您希望使用 npm 也完全没问题，只是在安装依赖时可能需要多花一些时间。

运行桌面端程序

yarn install

yarn start

运行浏览器程序

cd src/browser&&npm install

yarn start

提高效率

如果想提高开发效率，可以安装 Angular 官方提供的命令行 Angular-cli 快速生成组件、服务等模板。

yarn add @angular/cli --global

内置命令

运行命令

命令	描述
yarn start	开发模式下，同时运行在浏览器和桌面端
yarn start:zh	中文开发模式，同时运行在浏览器和桌面端
yarn start:web	仅运行在浏览器,同时开启后端代理
yarn start:electron	仅运行在桌面端

本项目 i18n 使用的是编译手段，所以开发时无法切换语言

打包构建

命令	描述
sudo yarn build	各系统打包 Electron 应用

运行测试

命令	描述
yarn test	执行单元测试

postcat's Issues

Where is the code for the proxy module

找不到proxy代理在哪边，有时候测试接口没反应

Fix Modal and dropdown cover the browserview

relate issue：electron/electron#16854

train of thought：

• browserview z-index
• new a browserview to mock dropdown and modal
• set main view background transparent，setTopBrowserView change view z-index

The number type should not have a minimum and maximum length

drag api group tree error when save

Trying to use eoapi, but I am very confused about how to deploy on Alibaba Cloud

代码已经下载到阿里云并编译好，nginx 也配置好，但是测试api提示 Request URL: https://172.17.12.4/api/unit 403 。想知道后台服务nginx如何配置？是否能提供一下linux+nginx 的部署教程，十分感谢！[email protected].

nginx

location / {

	root /data/eoapi/code/eoapi/src/workbench/browser/dist/;
    try_files $uri $uri/ /index.html;
    
}

change the eoapi struture

目录结构

逻辑先判断功能上属于哪一块，再判断运行环境在哪去放置代码模块。

根目录

• share: 提供通用服务和 UI 组件
• platform: 提供和平台有关的服务和 UI 组件
• app: 入口配置，初始化一些内容
• core：核心插件，例如：API 接口管理、插件市场应用、
• workbench: 核心工作区，目前有顶部导航栏、侧栏、底部 toolbar，以后可能有菜单栏设置

运行环境

• common: 只使用 javascritp api 的代码，能在任何环境下运行
• browser: 浏览器 api, 如操作 dom; 可以调用 common
• node: 需要使用 node 的 api,比如文件 io 操作
• electron-brower: 渲染进程 api, 可以调用 common, brower, node, 依赖 electron renderer-process API
• electron-main: 主进程 api, 可以调用: common, node 依赖于electron main-process AP

The `project` it should be a object type

{
  "environment": [],
  "group": [],
  "project": [{ "uuid": 1, "name": "Default" }],
  "apiData": [],
  "version": "0.0.3-beta"
}

When you are in the document module of the official website, click to switch to English, and the page displays abnormally

Phenomenon and recurrence steps:

As shown in the figure, visit the official website（ https://www.eoapi.io/ ）After that, click the "document" module, then click "select language" and select "English". An exception will appear on the page

Other information

Google Chrome
Version 101.0.4951.41 (official version) (arm64)

PC
MacBook Air (M1, 2020)
version 12.3 Monterey

---

I like EO API very much. I hope it will be better and better!!

源码使用nodejs ci 运行时出现错误

Describe the bug
源码使用nodejs ci 运行时出现错误

源码包：eoapi-0.0.1-beta.zip
nodejs版本 16.14.2

Environment managemetn： new env should has placeholder name："new Environment"

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Waiting time to start is too long in win10+

As the title says, it needs more than 10s in windows 10.
It will pop up a prompt while waiting, but it was too fast to close and I can 't see what it show.

The main window is not in the center of the screen

When opening the eoapi, the main window is off the bottom right corner of the screen.

OS: Windows 10.0.19044.1826
Version: 1.3.0 beta

希望可以增加全局变量配置

不同环境中，很可能使用的变量是一样的。当前只能在环境里面增加各自的环境变量，不是很方便。

Extension tips change link

Extension market changed to link

Export OpenAPI error

The page is still the old data after saving the environment

env has changed

https should be displayed here

The application cannot be closed by clicking the Close button in the production environment

Before opening an issue, we recommend:

• Use English to communicate.
• Search for duplicates of Issues and Discussions unresolved.

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Version [e.g. 22]

Additional context
Add any other context about the problem here.

Set enum value hidden too deep

Are there plans to support importing interfaces on existing Eolink?

Such as the title

部分API没有显示“编辑”、“测试”、“文档”菜单

如下图对比

操作系统：Windows 10 21H2 19044.1766
软件版本：1.2.5.0 pre

HTTP API Request Response too big to show

增加一个 富文本框 字段，用于编写文档说明、功能描述；

增加一个 富文本框 字段，用于编写文档说明、功能描述；

返回结果 那个黑色的代码区域 默认高度太小了，增加默认高度。

Unable to preview non-text data

application/json 无法解析吗

openapi 格式的文档导入

• 支持 openapi 格式的文档导入吗?

How API Testing Works in Node

前端是怎么发起测试的呀，我用过axios，fetch，ajax 这些框架。你们好像用的node测试，没使用过，能给个案例嘛，我好研究研究

最小化、关闭、最大化按钮没有反应

安装完成后，直接打开，三个按钮都没有反应，后台关闭后再次打开也一样
操作系统：Windows 10 21H2 19044.1766
软件版本：1.2.5.0 pre

Table Operation show fixed Right

Small screen users cannot see actions

Extension market web preview

这里改成，目前 web 端暂不支持插件广场，请【下载桌面端】（绿色按钮）；
然后点击后展示下拉框如图；

是否会增加文档分享功能

如题，提供一个公开或者可以设置密码的链接，分享出去给需要对接的人员查看API

Layout resizing

1、左侧边栏是否可以增加左右调整尺寸的功能，如果接口保存后的命名过长，被省略号替换掉了，那后续部分看不见，恰好前面部分文字又一样的话，很容易困惑。

2、对于返回结果的数据区域，可视区过于小气了，固定高度，而且只显示了一丁点，还要上下滚动，是否可以参照 postMan 那样布局，返回数据区域整体放置到右侧，采取 100 vh 高度，查看返回数据更加便捷一些

Open a new api, the content will not be saved, click +, the new tab page has the same content as the previous tab page

如图，点击+后新出来的New api和之前的new api内容一模一样

版本：1.3.0
操作系统：win10 21H2

与postman的区别在哪里？

API test support download response after test

@mojimaomao suggest
llike postman

保存的API信息没了

本来创建了两个分组，保存了2个API，刚刚添加第3个的时候，提示保存成功，但是分组里面看不到，把软件重启后，之前保存的API也没有了

Header parameters are converted to lowercase

Header 参数会转化成小写

Test history optimization

1. The test history should record environmental information. When restoring, intelligently determine whether to add a domain name, or let the user choose whether to keep the domain name when restoring the history.
2. All headers should be displayed when restoring request headers
   

The import popup should display a well-formatted prompt

Users will wonder if these two are the same thing

Confuse design

Global variable clear after reflesh tab

Install default extension will case debug error

After execute npm install,this link npm will be remove

The response is text but isn't shown in eoapi 1.2.0-beta

This is the response.

Enviroment manage inital select status error

1. After the drop-down selected environment opens the modal, it should be selected by default

origin：outside select env 【pro】，modal inside select env 【dev】
hope：outside select=modal select

2. The edited environment should remain selected after saving

save 【pro】

after save,jump to 【dev】

能否增加 multipart/form-data 类型

普通表单有了，另外一种传统混合文件上传的表单格式 multipart/form-data 能否也提供支持？

json数组里面的元素是无名的，这个应该怎么输入啊

这种json格式不支持的吗？或者说这种格式应该怎么输入啊？

Change uri cancel select queryParams

Support for GraphQL

背景：现在web端的产品都在使用graphql来进行接口说明。
需求：快速生成query和muation测试case，参考postman

Is it possible to see all request history

是否可以添加一个请求历史的功能，或许我可以能够查看历史请求例如 Postman 的历史一样。

Api management test error

need load main script unitWorker

delete API but still see it

The API still here after delete it in UI. I need to refresh then see it works.

mock数据添加不成功

mock数据一直添加不成功