Postcat 如何生成接口文档,2 分钟学会

news/2024/10/21 3:29:29/

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

作为代码的下游 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 的数据无法同步过来了。

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

Github :

https://github.com/Postcatlab/postcat


http://www.ppmy.cn/news/48361.html

相关文章

科普丨关于 A/B 测试的十问十答

你想知道的,都在这里!本文是神策数据「十问十答」科普系列文章的第二期,围绕 A/B 测试展开。 1 Q:什么是 A/B 测试? A:A/B 测试作为互联网企业的核心增长手段之一,其价值已在实际应用中被多次验…

“王炸”组合竞逐「行泊一体」

去年开始,在中国市场,「行泊一体」的热度,不亚于当年特斯拉推出FSD,甚至更加火热。从上游芯片、传感器,到域控制器、智能驾驶系统供应商以及车企,都在公开场合不断普及这个组合功能。 「行泊一体」市场的启…

半导体存储电路

半导体存储电路 SR锁存器和触发器寄存器存储器存储器分类RAMSRAMDRAM ROMMROMPROMEPROMEEPROMFLASH原理发现者应用工作原理存储单元 磁盘硬盘机械硬盘(HDD)固态硬盘(SSD) SR锁存器和触发器 SR锁存器用于记忆1位二进制信号&#x…

File类与IO流

1. java.io.File类的使用 1.1 概述 File类及本章下的各种流,都定义在java.io包下。一个File对象代表硬盘或网络中可能存在的一个文件或者文件目录(俗称文件夹),与平台无关。(体会万事万物皆对象)File 能新…

4.7 贝塞尔曲线

学习目标: 学习贝塞尔曲线可以遵循以下步骤: 1.了解基本概念和定义:学习贝塞尔曲线前需要了解贝塞尔曲线的基本概念和定义,如何定义一条贝塞尔曲线、控制点的概念以及贝塞尔曲线的几何性质等。 2.学习贝塞尔曲线的构造方法&…

一文解决nltk安装问题ModuleNotFoundError: No module named ‘nltk‘,保姆级教程

目录 问题一:No module named ‘nltk‘ 问题二:Please use the NLTK Downloader to obtain the resource 下载科学上网工具 问题三:套娃报错 如果会科学上网,可以直接看问题三 问题一:No module named ‘nltk‘ Mo…

cdh Hue集成sentry的权限管理详细步骤

hue登录hue的第一个用户要用hue用户创建,默认hue为超级用户,hue用户页面的权限可以管理很多用户操作,比如查看hdfs目录,使用其他组件,授权功能等等 一.hive的配置 1.关闭模拟,开启sentry 2.添加配置(注意配置的位置) <property> <name>sentry.hive.tes…

Linux常用命令50个含示例

下面是50个常用的Linux命令&#xff0c;以及它们的使用示例和常用参数&#xff1a; ls&#xff1a;列出目录下的文件和子目录。 示例&#xff1a;ls /home/user/ 常用参数&#xff1a;-l 显示详细信息&#xff0c;-a 显示所有文件&#xff08;包括隐藏文件&#xff09;&#xf…