Swagger 是一个标准且残缺的框架，用于生成、形容、调用和可视化 RESTful 格调的 Web 服务。
Swagger 的指标是对 REST API 定义一个规范且和语言无关的接口，能够让人和计算机领有毋庸拜访源码、文档或网络流量监测就能够发现和了解服务的能力。当通过 Swagger 进行正确定义，用户能够了解近程服务并应用起码实现逻辑与近程服务进行交互。与为底层编程所实现的接口相似，Swagger 打消了调用服务时可能会有的猜想。
Swagger 的劣势
- 反对 API 主动生成同步的在线文档：应用 Swagger 后能够间接通过代码生成文档，不再须要本人手动编写接口文档了，对程序员来说十分不便，能够节约写文档的工夫去学习新技术。
- 提供 Web 页面在线测试 API：光有文档还不够，Swagger 生成的文档还反对在线测试。参数和格局都定好了，间接在界面上输出参数对应的值即可在线测试接口。
但相比于 Swagger 我更举荐这个国产的 开源 API 管理工具——Postcat
Postcat 和 Swagger 有什么区别呢？
Postcat 插件不会入侵到代码外部，无需增加任何 jar 包依赖
插件通过剖析用户正文进行接口解析，最终生成接口文档并上传至 Postcat 服务器，使得开发者能够在 Postcat 上进行 API 治理和分享，进步合作能力和开发速度。
Postcat 提供了多种拓展正文 ，如@path、@url、@method、@name、@hidden 和@required，这些正文能够在设置界面进行自定义或兼容现有正文。
此外，Postcat 还提供了正文生成性能，对于没有或仅有大量正文的类和办法，开发者无需费劲手动增加，该性能能够分析方法字段含意并主动生成正文。开发者只须要查看或依据理论场景进行微调，即可生成一份较欠缺的 API 文档。
如果原有正文有余，Postcat 会通过增加形式补充正文，移除正文时只会移除 Postcat 提供的那些拓展性正文，不会毁坏用户本身的正文。同时，开发者还能够应用 ” 用意 ” 性能部分生成插件正文，并进行调整和批改。
Postcat 提供了多种 API 上传形式，不便开发者在不同的场景下应用：
- 对于首次应用 Postcat 的现有我的项目，开发者能够应用主菜单中 Tools 分组下的 Upload Project Api Doc 来实现我的项目级别的接口上传。
- 对于新需要下创立的 Controller，在实现接口定义后，开发者能够右键菜单，抉择 Upload All Api 来进行单个文件级别全副上传，做到先有文档再有逻辑，前后端工作不再串行阻塞。
- 对于某个局部独自接口的改变，无需全副上传，开发者能够右键菜单，抉择 Upload Api 性能，该性能会展现以后编辑类的接口信息，并提供接口预览和接口抉择界面，使得用户能够勾选须要更新或上传的指标 API 进行信息核查和上传。
理解 Postcat：
Postcat 是一个弱小的开源、跨平台（Windows、Mac、Linux、Browsers…）的 API 开发测试工具，反对 REST、Websocket 等协定（行将反对 GraphQL、gRPC、TCP、UDP），帮忙你减速实现 API 开发和测试工作。
Postcat 外围性能：
- API 文档治理：可视化 API 设计，生成 API 文档
- API 测试：主动生成测试参数，主动生成测试用例，可视化数据编辑
- 插件拓展：泛滥插件扩大产品性能，打造属于你和团队的 API 开发平台
- Mock：依据文档主动生成 Mock, 或创立自定义 Mock 满足简单场景
- 团队合作：既能实现 API 分享也能能够创立云空间独特合作
Postcat 劣势：
- 免登录即可测试：省去繁琐的验证登录的操作
- 界面简洁：没有冗余的性能与简单选项
- 收费：中小团队以及集体应用
- 丰盛的插件：反对多种格局数据迁徙、主题、API 平安等近 30 款插件
- 国产：能更好的了解国内用户的需要，与开发团队沟通无障碍
- 欠缺的用户文档：跟着操作就能疾速上手
多提 Issue ! 多反馈！
在应用过程中有任何疑难，能够进群交换：
也能够在线提 Issue（强烈推荐这种开源的形式），提问题自身就曾经在奉献社区了：
https://github.com/Postcatlab/postcat/issues
如果喜爱，无妨 Star 反对一下
这个我的项目是开源的，如果你感觉这个我的项目还不错的话，无妨点个 Star 反对一下！
Github：https://github.com/Postcatlab/postcat