本次版本更新主要围绕这几个方面:
从 Swagger URL 同步 API
API 编辑页面自动调整编辑器高度
Windows 安装包自定义 UI
但我最想说的还是这个 【从Swagger URL 同步 API】 的部分,也是本次更新的重点。
对于中小型(特别是 Java 技术栈)的开发团队来说,Swagger 是一个便捷的选择,好处是:
代码即文档,编写成本低,不存在同步不及时的问题;
生态好,各大 API 平台都支持基于 OpenAPI 格式的拓展。
但使用 Swagger 的用户有以下几个痛点:
测试不方便,有简单的调用测试,但是没有历史也没有鉴权等功能;
没有人员管理,无法协作/通知/版本管理;
对于前端人员不友好,没有参数描述/值可能性,没有 Mock ;
对代码有侵入性。
我们不追求让大家强制切换工具,而是作为代码的下游 API 文档工具,解决痛点的同时融合 Swagger 生态。
Postcat 通过以下两种方式支持代码生成文档:
如果你之前使用 Swagger,我们支持从 Swagger Url 自动同步 Swagger 数据;