Swagger URL 插件上线!同步文档更加简单!


版本更新亮点:

  • 从 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 插件才行   首先,找到对应插件,并安装     选择通过 URL 导入同步 API     填写 Swagger URL 地址:     导入成功,右侧展示了新增的 API     在 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        

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

  这个项目是开源的,如果你觉得这个项目还不错的话,不妨点个 Star 支持一下!   Github : https://github.com/Postcatlab/postcat   Gitee: https://gitee.com/eolink_admin/postcat

 

 


相關推薦

2022-09-30

发和配置一个可用的 Data API!   Tapdata 中也集成了 Swagger 的 API 文档和简单测试,如果你要对 API 进行协作、Mock、更全面的测试,可以通过将 Tapdata 的数据一键导出后导入到 Eoapi 上使用~   如何使用 Tapdata 插件  

2022-11-08

功API即把文档同步到云端,API文档中的注释支持javadoc、swagger,无需过多额外的书写。     Api文档显示返回值类型参数文档 增加了返回值类型的自动解析   公共请求头 此功能帮助快速添加一些比较常用的 He

2023-08-26

后,不能跳转到主页的问题 [#883] 修复自定义接口的 Swagger 接口定义错误问题 [#879] 修复 DB2 库表元数据扫描,建表语句审核有误的问题 [#875] 修复 DB2 库表元数据扫描失败的问题

2022-11-03

he Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就

2023-07-26

功能 本次更新的主要亮点,是新增了一系列功能丰富的插件。让我们一起来了解一下!   1. 重要新增 | 采集插件 这次,我们为您带来了全新的商品采集工具,让您的商品上架工作变得更加高效 该插件,支持采集多

2024-06-29

处理特殊字符的问题 [#2348] 解决 SQLE 异常退出后残留插件进程的问题 [#2457] 修复审核 MySQL 某条规则导致 SQLE panic 的问题 [#2452] 修复中文名 ZIP 包审核报错的问题 [#2451] 修复实例名筛选 SQL 工单报错的问题   企

2023-07-11

he Dubbo rpc 接口文档生成的工具,smart-doc 颠覆了传统类似 swagger 这种大量采用注解侵入来生成文档的实现方法。 smart-doc 完全基于接口源码分析来生成接口文档,完全做到零注解侵入,你只需要按照 java 标准注释编写,smart-doc 就

2022-08-13

Vue 创始人尤雨溪宣布,新版 Vue 3 中文文档上线了! 地址:cn.vuejs.org 其他变化: 原先的 Vue 2 文档现在迁移到了 v2.cn.vuejs.org 之前的临时 v3 文档 (http://v3.cn.vuejs.org) 不再提供,会重定向到最新版对应的 URL http://staging-

2024-08-27

亲和性 具备全链路调用日志跟踪特性 业务框架提供了插件机制,插件是可插拨、可扩展的 JSR380验证、断言 + 异常机制 = 更少的维护成本 action 支持自动装箱、拆箱基础类型,用于解决协议碎片的问题 ioGame 是一个专

2022-01-10

微软日前发布了一个名为「IndexNow Plugin」的 WordPress 插件,让开发者/作者的 WordPress 网站/博客能够与 IndexNow 协议更加轻松地进行整合。目前该插件已可在 WordPress 官网的插件菜单中找到。 IndexNow 本身是微软 Bing 与俄罗斯 Yandex

2023-06-16

对于原来的 30元/人/月直降 50%!   1.2 空间主页上线作为系统首页 升级后登录系统默认进入空间主页,空间主页中左侧菜单栏有 API 管理和自动化测试等应用的项目列表页入口,方便快速切换应用项目。 并且原应用模

2023-11-23

生成可以大大提升开发效率,欢迎体验​。 特性 go-swagger : 基于go-swagger而不是官方的@doc注解 多国语言支持 优化错误信息处理,支持多语言错误 简单易用的校验器 支持代码生成,生成API,RPC 和 web 端的CRUD代码 支持多

2023-03-10

更新亮点 Postcat 本次新增了 ChatGPT 插件,不用注册,直接可以使用原汁原味的 ChatGPT。 如何使用 访问 Postcat.com,直接使用github 账号登录或者注册:     右上角【插件广场】,找到 Chatgpt 插件,安装  

2023-07-18

,可通过如下的预处理脚本一键从 Kubernetes 仓库下载的 swagger.json 文件转换为 KCL 包,将如下命令的 1.27 改为需要的 Kubernetes 版本即可 version=1.27 spec_path=swagger.json script_path=main.py wget https://raw.githubusercontent.com/kubernetes/kubernetes/rel