File: README.md
⚠️ 项目状态说明
本项目目前已进入 暂停维护。
由于不可抗力因素，Postcat 开源项目自即日起将不再进行功能迭代与日常维护，未来也将不再提供新的功能更新与安全修复。
如果你仍在生产环境中使用本项目，请务必自行评估风险，并考虑迁移到 Apikit.com 或其他替代方案。
感谢所有贡献者与用户多年来的支持与陪伴。
Postcat API 客户端（Client）
概述
Postcat 是一个强大的开源、免费的、跨平台（Windows、Mac、Linux、Browsers...）的 API 开发测试工具，支持 REST、Websocket 等协议（即将支持 GraphQL、gRPC、TCP、UDP），帮助你加速完成 API 开发和测试工作。它非常适合中小团队及个人使用。
我们在保证 Postcat 轻巧灵活的同时，还为它设计了一个强大的插件系统，让您可以一键使用插件来增强它的功能。
因此 Postcat 理论上是一个拥有无限可能的 API 产品，可以从Logo 中看到，我们也形象地为它加上了一件披风，代表它的无限可能。
免登录在线使用或下载
Postcat 现在已经支持 Windows、Mac、Linux等系统，你可以通过以下地址访问并下载。同时我们也提供了 Web 端，方便你在任何浏览器上使用。
如果您试用之后觉得不错，请给我们的Postcat一个 Star 和 Fork~你的支持是我们不断改进产品的动力！
详细的文档
功能特性和迭代计划（Roadmap）
- 🚀 多协议支持
-- 已实现：HTTP REST、Websocket
-- 即将实现：GraphQL、TCP、UDP、gRPC
📕 API 文档
✨ API 设计
⚡ API 测试
🎭 Mock
🙌 团队协作
🎈 文档分享
🗺 环境
🧶 全局变量
🧩 自定义主题风格
🌐 多语言支持：中文、English
了解更多具体迭代计划：Github Project
也欢迎给我们多多提需求~
友情链接
- APIPark - 专业的API服务平台
💪 贡献者 💪
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 | 执行单元测试 |
File: src/browser/README.md
Postcat Workbench
Postcat browser code
Run
| Command | Desc |
|---|---|
yarn start |
Only run frontend,local workspace |
yarn serve |
Use proxy |
yarn build |
Pack static frontend resource |
File: src/node/test-server/server/README.md
Postcat-Test-Server
Only deploy in web server.
Recieve postcat test config and response http result
This service does not automatically install dependencies,please install it manually
Command
dev/star
yarn startFile: src/node/test-server/README.md
Node Test server
warning: If the root directory exists,package.json dependencies need added to root package.json
need yarn globally
Debug Test Server
- Run Test Server in this directory
yarn dev- Run the core system in root directory
yarn startFile: wiki/README.en.md
⚠️ Project Status Notice
This project is now in a maintenance suspended state.
Due to unforeseen circumstances beyond our control, the Postcat open source project is no longer actively maintained as of now.
No new features, regular maintenance, or security fixes will be provided in the future.
If you are using this project in production, please carefully evaluate the risks and consider migrating to actively maintained alternatives.
Thank you to all contributors and users for your support over the years.
Postcat API Client
`🛠️ A Little Update, A Big Transformation: Postcat is Undergoing a Revamp! 🚀
Hey there, Postcat friends!
Just a quick shout-out to let you all know that our project is currently on an exciting journey of restructuring. It's not that Postcat is unattended; in fact, we're actively injecting new energy into it!
Things might seem a bit quiet for now, but rest assured, we're busy behind the scenes. We're committed to making Postcat cooler and more user-friendly - it just takes a bit of time to polish and perfect.
So, stay tuned! Soon, you'll be meeting a revamped and rejuvenated Postcat. Your support and patience mean the world to us!
Exciting updates are on the horizon, stay tuned!`
Postcat is a powerful open source, cross-platform (Windows, Mac, Linux, Browsers...) API development and testing tool that supports REST, Websocket and other protocols (soon to support GraphQL, gRPC, TCP, UDP), helping you speed up the completion of API Development and testing work.
While ensuring that Postcat is light and flexible, we also designed a powerful plug-in system for Postcat, allowing you to use plug-ins with one click to enhance Postcat's functions.
Therefore, Postcat is theoretically an API product with infinite possibilities. We also visually added a cape to Postcat's cat, representing its infinite possibilities.
Roadmap
- 🚀 Multi-protocol support
-- Implemented: HTTP REST, Websocket
-- Coming soon: GraphQL, TCP, UDP, gRPC - 📕 API Documentation
- ✨ API Design
- ⚡ API Test
- 🎭 Mock
- 🙌 Collaboration
- 🎈 Document Sharing
- 🗺 Environment
- 🧶 Global variables
- 🧩 Custom theme style
- 🌐 Multilingual support: Chinese, English
Learn more：Github Project
💪 Contributors 💪
Bug and Feature Request
If you'd like to contact us, please create a Github issue. Thank you!
Document
Build and run
Prerequisites
- Node.js >= 14.17.x
- yarn >= 1.22.x
Running the code
We use yarn as a package management tool for development and building, and it is highly recommended that you do the same, but if you want to use npm it's perfectly fine, it just might take a little more time to install dependencies.
yarn install
yarn startIf you want to improve Angular development efficiency, you can install the command-line Angular-cli officially provided by Angular to quickly generate templates such as components and services.
yarn add @angular/cli --globalCommand
Run
| Command | Description |
|---|---|
yarn start |
In development mode, running on browser and desktop at the same time |
yarn serve:web |
only runs in the web |
yarn electron:serve |
only runs in the desktop |
Build
| Command | Description |
|---|---|
yarn build |
Packaging Electron applications for each platform |
Running the tests
| Command | Description |
|---|---|
yarn test |
Execute unit tests |