Swagger URL 插件上线!同步文档更便捷!

简介: Swagger 的用户有以下几个痛点:- 测试不方便,有简单的调用测试,但是没有历史也没有鉴权等功能;- 没有人员管理,无法协作/通知/版本管理;- 对于前端人员不友好,没有参数描述/值可能性,没有 Mock ;- 对代码有侵入性。

本次版本更新主要围绕这几个方面:

  • 从 Swagger URL 同步 API
  • API 编辑页面自动调整编辑器高度
  • Windows 安装包自定义 UI


但我最想说的还是这个 【从Swagger URL 同步 API】 的部分,也是本次更新的重点。


对于中小型(特别是 Java 技术栈)的开发团队来说,Swagger 是一个便捷的选择,好处是:

  • 代码即文档,编写成本低,不存在同步不及时的问题;
  • 生态好,各大 API 平台都支持基于 OpenAPI 格式的拓展。


但使用 Swagger 的用户有以下几个痛点:

  • 测试不方便,有简单的调用测试,但是没有历史也没有鉴权等功能;
  • 没有人员管理,无法协作/通知/版本管理;
  • 对于前端人员不友好,没有参数描述/值可能性,没有 Mock ;
  • 对代码有侵入性。


我们不追求让大家强制切换工具,而是作为代码的下游 API 文档工具,解决痛点的同时融合 Swagger 生态。

Postcat 通过以下两种方式支持代码生成文档:

  1. 如果你之前使用 Swagger,我们支持从 Swagger Url 自动同步 Swagger 数据;
  2. Jebrains IDE  插件,安装后可以在 IDE 中右键一键同步代码注释中的 API 文档信息到 Postcat。(下一篇内容会讲到)


下面即为大家演示如何如何支持 Swagger Url 自动同步 Swagger 数据

从 Swagger URL 生成文档


提示:要使用这个功能,一定得安装 Swagger URL 插件才行


首先,找到对应插件,并安装

01.gif


选择通过 URL 导入同步 API

02.gif

填写 Swagger URL 地址:

03.png

导入成功,右侧展示了新增的 API

04.png


在 Postcat 上只要通过安装这个导入插件,再也不用担心 Swagger 的数据无法同步过来了。





了解 Postcat:


Postcat 是一个强大的开源、跨平台(Windows、Mac、Linux、Browsers...)的 API 开发测试工具,支持 REST、Websocket 等协议(即将支持 GraphQL、gRPC、TCP、UDP),帮助你加速完成 API 开发和测试工作。


Postcat 核心功能:

  1. API 文档管理:可视化 API 设计,生成 API 文档
  2. API 测试:自动生成测试参数,自动生成测试用例,可视化数据编辑
  3. 插件拓展:众多插件扩展产品功能,打造属于你和团队的 API 开发平台
  4. Mock:根据文档自动生成Mock,或创建自定义 Mock 满足复杂场景
  5. 团队协作:既能实现API 分享也能可以创建云空间共同协作


Postcat 优势:

  1. 免登录即可测试:省去繁琐的验证登录的操作
  2. 界面简洁:没有冗余的功能与复杂选项
  3. 免费:中小团队以及个人使用
  4. 丰富的插件:支持数据迁移、主题、API 安全等高达22款插件
  5. 国产:能更好的理解国内用户的需求,与开发团队沟通无障碍
  6. 完善的用户文档:跟着操作就能快速上手


多提 Issue !多反馈!


在使用过程中有任何疑问,可以在线提 Issue(强烈推荐这种开源的方式),提问题本身就已经在贡献社区了:


https://github.com/Postcatlab/postcat/issues


06.png




如果喜欢,不妨Star 支持一下


这个项目是开源的,如果你觉得这个项目还不错的话,不妨点个 Star 支持一下!


Github :

https://github.com/Postcatlab/postcat





相关文章
|
6月前
|
Oracle 关系型数据库 Java
程序员必备推荐一款与Swagger媲美的数据库文档生成工具
程序员必备推荐一款与Swagger媲美的数据库文档生成工具
74 0
|
6月前
|
数据可视化 Linux API
如何在Linux使用docker部署Swagger Editor并实现无公网IP远程协同编辑API文档
如何在Linux使用docker部署Swagger Editor并实现无公网IP远程协同编辑API文档
|
6月前
|
数据可视化 Linux API
使用Docker安装部署Swagger Editor并远程访问编辑API文档
使用Docker安装部署Swagger Editor并远程访问编辑API文档
123 0
|
4月前
|
Java API 开发者
在Spring Boot中集成Swagger API文档
在Spring Boot中集成Swagger API文档
|
23天前
|
安全 Java API
SpringSecurity结合knife4j实现swagger文档
通过将Spring Security与Knife4j相结合,我们不仅能够为RESTful API提供强大的安全防护,还能保证API文档的易用性和可访问性,这对于API的设计、开发和维护来说至关重要。这种集成方式不仅提升了开发效率,也优化了API使用者的体验,是现代API驱动开发中不可或缺的一环。
55 0
|
3月前
|
JSON 测试技术 API
Python开发解析Swagger文档小工具
文章介绍了如何使用Python开发一个解析Swagger文档的小工具,该工具可以生成符合httprunner测试框架的json/yaml测试用例,同时还能输出Excel文件,以方便测试人员根据不同需求使用。文章提供了详细的开发步骤、环境配置和使用示例,并鼓励读者为该开源项目贡献代码和建议。
66 1
Python开发解析Swagger文档小工具
|
4月前
|
Web App开发 前端开发 JavaScript
Chrome插件实现问题之用户在浏览器中输入URL后,浏览器进程会进行什么操作
Chrome插件实现问题之用户在浏览器中输入URL后,浏览器进程会进行什么操作
|
4月前
|
缓存 安全 Web App开发
Chrome插件实现问题之网络进程接收到URL请求后会如何解决
Chrome插件实现问题之网络进程接收到URL请求后会如何解决
|
4月前
|
安全 Java API
Nest.js 实战 (三):使用 Swagger 优雅地生成 API 文档
这篇文章介绍了Swagger,它是一组开源工具,围绕OpenAPI规范帮助设计、构建、记录和使用RESTAPI。文章主要讨论了Swagger的主要工具,包括SwaggerEditor、SwaggerUI、SwaggerCodegen等。然后介绍了如何在Nest框架中集成Swagger,展示了安装依赖、定义DTO和控制器等步骤,以及如何使用Swagger装饰器。文章最后总结说,集成Swagger文档可以自动生成和维护API文档,规范API标准化和一致性,但会增加开发者工作量,需要保持注释和装饰器的准确性。
123 0
Nest.js 实战 (三):使用 Swagger 优雅地生成 API 文档
|
5月前
|
Java API Spring
Spring Boot中配置Swagger用于API文档
Spring Boot中配置Swagger用于API文档