首页 > 其他分享 >支持生成接口文档!Apipost IDEA插件使用体验

支持生成接口文档!Apipost IDEA插件使用体验

时间:2023-12-07 18:45:56浏览次数:36  
标签:插件 Apipost IDEA 接口 API 文档 调试

前言

Idea 是一款功能强大的集成开发环境(IDE),它可以帮助开发人员更加高效地编写、调试和部署软件应用程序,Idea 还具有许多插件和扩展,可以根据开发人员的需要进行定制和扩展,从而提高开发效率,今天我们就来介绍一款国产的API调试插件:Apipost-Helper

什么是Apipost-Helper?

Apipost-Helper是一款在IntelliJ IDEA编辑器中的插件,这款插件是Apipost团队开发的,其官方介绍是:用于IDEA项目快速生成API文档,快速查询接口、接口代码功能,并支持在IDEA中进行API调试操作。

为什么要使用它?

使用Apipost-Helper主要有以下几个功能:

代码零入侵,一键生成API文档

编写完代码后,右键点击 「Upload to Apipost」即可快速将源码中包含的API以及注解同步至Apipost中,并生成可以访问的API文档链接。

 

代码写完快速调试API

代码编写完成后,可以点击右侧Apipost图标进行快速调试,调试功能新增header、host配置

 

根据API搜索对应源码、接口树

右侧接口调试栏新增搜索功能可以根据API搜索对应源码、接口树

根据API搜索对应源码:

 

根据API在接口数中搜索API:

 

根据源码method跳转到对应API树处

接口代码处展示箭头图标,点击即可快速跳转至对应接口列表处

 

支持自动识别、创建目录

在设置中可以配置同步API时的上传方式

自动新建类注释目录:

上传时选择到项目,自动创建目录,创建的目录为类的注释,如果没有注释则为类名,注释优先级为文档注释标记@module > @menu > @Api(swagger) > 文档注释第一行

手动选择项目中目录:

上传时可选择到目录下或者项目下,旧版本为此模式,当前默认为此模式

 

最后

本文主要介绍了Apipost-Helper插件,希望对大家有所帮助,以上内容就到这里,感谢各位看官老爷们的观看,如果觉得写得好,给个赞支持一下哈!!!

标签:插件,Apipost,IDEA,接口,API,文档,调试
From: https://www.cnblogs.com/meimaodachong/p/17883672.html

相关文章

  • 超级好用的IDEA插件推荐
    IDEA是一款功能强大的集成开发环境(IDE),它可以帮助开发人员更加高效地编写、调试和部署软件应用程序。我们在编写完接口代码后需要进行接口调试等操作,一般需要打开额外的调试工具。今天给大家介绍一款IDEA插件:Apipost-Helper-2.0。代码写完直接编辑器内调试、还支持生成接口文档、......
  • HydroOJ 从入门到入土(5)插件集锦
    总有些需求,未必有啥用,但是很可爱.本文将介绍一些插件相关的知识,并不专业,因为我不懂js(逃目录1.关于插件2.官方插件3.三方插件4.官方站上的第三方插件1.关于插件插件使用js/ts语言编写.插件功能强大,分前后端,可以干任何事情,所以尽量不要使用来路不......
  • pycharm插件离线安装
    给不能联网的电脑或者不能访问外网的云桌面安装pycharm插件,需要离线安装首先在能访问网络的电脑上打开插件主页,如下:下载插件安装文件   ......
  • vscode-go语言插件,调试器协议分析(二)
    版本信息Server:{"Commands":["gopls.add_dependency","gopls.add_import","gopls.add_telemetry_counters","gopls.apply_fix","gopls.change_signature","gopls.check_u......
  • IntelliJ IDEA无公网远程Linux服务器环境开发(建议收藏!)
    IDEA的远程开发功能,可以将本地的编译、构建、调试、运行等工作都放在远程服务器上执行,而本地仅运行客户端软件进行常规的开发操作即可,旧版本IDEA目前不支持该功能.,本例使用的是IDEA2023.2.5版本下面介绍如何在IDEA中设置远程连接服务器开发环境并结合Cpolar内网穿透工具实现无......
  • vscode-go语言插件,调试器协议分析
    c客户端,vscodes服务端,调试器----------------------------------------------c-->客户端,请求调试器初始化{"command":"initialize","arguments":{"clientID":"vscode","clientName":......
  • IDEA项目重命名的修改问题
    问题:IDEA的项目想更改文件名改完之后出现之前可以运行的代码都无法运行 如果出现项目名称后面有一个[]这就说明你的项目名称和pom中的项目名称不一致,后面的为pom中的名称例如: 文件夹名字为A,Idea项目文件名为B.iml,打开后项目名显示为A[B],工程记录的名字为B,Maven工程名为B......
  • idea中git密码输入错误
    idea中git密码输入错误通过idea通过git上传代码时,git密码输入错误,导致验证失败。后面再上传代码时,idea不再弹出输入密码框,无法更改密码。具体修改方式是:idea打开file——》settings——》Appearance&Behavior——》SystemSettings——》Passwords,然后右侧勾选Protectmaster......
  • 为什么 idea 建议去掉 StringBuilder,使用“+”拼接字符串
    为什么idea建议去掉StringBuilder,使用“+”拼接字符串目录为什么idea建议去掉StringBuilder,使用“+”拼接字符串1、普通拼接2、循环拼接总结各位小伙伴在字符串拼接时应该都见过下面这种提示:内容翻译:报告StringBuffer、StringBuilder或StringJoiner的任何用法,这些用法......
  • 超好用的IDEA插件,完全免费
    IDEA是一款功能强大的集成开发环境(IDE),它可以帮助开发人员更加高效地编写、调试和部署软件应用程序。我们在编写完接口代码后需要进行接口调试等操作,一般需要打开额外的调试工具。今天给大家介绍一款IDEA插件:Apipost-Helper-2.0。代码写完直接编辑器内调试、还支持生成接口文档、接......