# Postcat **Repository Path**: eolink_admin/postcat ## Basic Information - **Project Name**: Postcat - **Description**: Postcat 是一个可扩展的 API 工具平台。 Postcat 集合基础的 API 管理和测试功能,并且可以通过插件简化你的 API 开发工作,让你可以更快更好地创建 API。 - **Primary Language**: JavaScript - **License**: MIT - **Default Branch**: main - **Homepage**: https://www.postcat.com - **GVP Project**: Yes ## Statistics - **Stars**: 790 - **Forks**: 200 - **Created**: 2022-05-27 - **Last Updated**: 2025-06-14 ## Categories & Tags **Categories**: api-gateway **Tags**: Electron, Angular, Nodejs, API, TypeScript ## README # Postcat API 客户端(Client) ![Postcat API Client](http://data.eolinker.com/course/QbLMSaJ7f3dcd0b075a7031b31f8acb486e0a090f1bdc8d.jpeg)

English | 简体中文

License Version Downloads Chat

## 🛠️ 小更新,大改变:Postcat 正在重构中! 🚀 嘿,Postcat 的朋友们! 只是想快速告诉大家,我们的项目现在正处在一次激动人心的重构旅程中。这并不意味着 Postcat 没有得到维护,恰恰相反,我们正在给它注入新的活力! 在这个阶段,可能会有些静悄悄的,但请相信,我们在幕后正忙得不可开交。我们致力于让 Postcat 变得更酷、更易用,只是需要一点时间来打磨和完善。 所以,请继续关注,不久的将来,你们会见到一个焕然一新的 Postcat。你的支持和耐心是我们最宝贵的动力! 敬请期待,更多精彩即将来临! ## 概述 **Postcat** 是一个强大的开源、免费的、跨平台(Windows、Mac、Linux、Browsers...)的 **API 开发测试工具**,支持 REST、Websocket 等协议(即将支持 GraphQL、gRPC、TCP、UDP),帮助你加速完成 API 开发和测试工作。它非常适合中小团队及个人使用。 ![Postcat UI](https://data.eolink.com/ImGzhCi79d0beb5b8221670dffceb61bf642af1960d3881) 我们在保证 **Postcat** 轻巧灵活的同时,还为它设计了一个强大的插件系统,让您可以一键使用插件来增强它的功能。 ![Postcat Extensions](https://data.eolink.com/22UMwcV01e087e3549edb91361f15a9ba8047e16d0d3f3f) 因此 **Postcat** 理论上是一个拥有无限可能的 API 产品,可以从Logo 中看到,我们也形象地为它加上了一件披风,代表它的无限可能。 ## 免登录在线使用或下载 **Postcat** 现在已经支持 Windows、Mac、Linux等系统,你可以通过以下地址访问并下载。同时我们也提供了 Web 端,方便你在任何浏览器上使用。 **[https://postcat.com/](https://postcat.com//)** 如果您试用之后觉得不错,**请给我们的Postcat一个 Star 和 Fork~**你的支持是我们不断改进产品的动力! ## 详细的文档 [Postcat 文档](https://docs.postcat.com/) [插件开发文档](https://developer.postcat.com/api/get-started.html) ## 功能特性和迭代计划(Roadmap) - 🚀 多协议支持 -- 已实现:HTTP REST、Websocket -- 即将实现:GraphQL、TCP、UDP、gRPC - 📕 API 文档 - ✨ API 设计 - ⚡ API 测试 - 🎭 Mock - 🙌 团队协作 - 🎈 文档分享 - 🗺 环境 - 🧶 全局变量 - 🧩 自定义主题风格 - 🌐 多语言支持:中文、English 了解更多具体迭代计划:[Github Project](https://github.com/orgs/Postcatlab/projects/3)
也欢迎给我们多多提需求~
## 💪 贡献者 💪

感谢你们让美好发生!

Power by contrib.rocks.
## Bug 和需求反馈 如果想要反馈 Bug、提供产品意见,可以创建一个 [Github issue](https://github.com/Postcatlab/postcat/issues) 联系我们,十分感谢! 如果您希望和 Postcat 团队近距离交流,讨论产品使用技巧以及了解更多产品最新进展,欢迎加入以下渠道。 - QQ群号码:981965807 - QQ群链接:[加入Postcat 用户群](https://jq.qq.com/?_wv=1027&k=Kej1qTUy) - 微信群: ![](http://data.eolinker.com/course/NKhRRF668370911c8b8ea8a0887b5d62e71b0f1a22ad76a.png) ## 开发 Postcat
运行代码
请确保你已经部署好所需的开发环境: - Node.js >= 14.17.x - yarn >= 1.22.x 我们在开发和构建时使用 yarn 作为包管理工具,强烈建议你也这么做,但如果您希望使用 npm 也完全没问题,只是在安装依赖时可能需要多花一些时间。 ### 运行桌面端程序 ```shell yarn install yarn start ``` ### 运行浏览器程序 ```shell 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 |执行单元测试 |