首页 > 其他分享 >一篇文章看懂 Apipost IDEA插件怎么用

一篇文章看懂 Apipost IDEA插件怎么用

时间:2023-07-11 11:31:39浏览次数:31  
标签:插件 同步 配置文件 Apipost 配置 IDEA API

Apipost最近也是推出了IDEA插件,只需要右键upload一下即可自动解析代码注解并快速生成 API 文档,小编也是试了试,这篇文章给大家带来详细的使用教程。

安装Apipost Helper

安装Apipost-Helper:打开IDEA,在右侧Plugin中搜索Apipost 点击Install 下载安装。

一篇文章看懂 Apipost IDEA插件怎么用_配置文件

配置方法:

安装成功后要将 IDEA 内的项目与 Apipost的项目进行关联。

  1. 在Apipost 「项目设置」>「对外能力」>「open API」中创建、复制 API-token、项目ID。

一篇文章看懂 Apipost IDEA插件怎么用_API_02

  1. 进入IDEA设置界面 >「Apipost Config」 中填写 API-token、项目ID。

一篇文章看懂 Apipost IDEA插件怎么用_配置文件_03

使用方法

同步API:配置完成后,后端研发在API代码编写、代码修改后右键点击“Upload to Apipost”,其他团队成员即可在 Apipost 中看到同步后的最新API文档。

一篇文章看懂 Apipost IDEA插件怎么用_API_04

同步API时选择同步目录:可以在 Settings > Apipost Config 「自定义目录」中配置。多目录可以用英文逗号分隔,子目录可以用斜杠分隔。

示例:Test1/Test1.2,Test2

一篇文章看懂 Apipost IDEA插件怎么用_API_05

配置完成后同步API时可选择目录:

一篇文章看懂 Apipost IDEA插件怎么用_端口号_06

前置URL配置:可以根据所选模块的配置文件获取对应的访问前缀,没有对应的配置文件,则需要自己填写,若配置文件中未配置端口号以及访问总路径则使用默认端口号8080。

配置方法:同样在Settings > Apipost Config 「前置URL配置」中配置,配置完成后,同步API时,会根据选择的目录将Perfix Url自动填入到Apipost接口中。

一篇文章看懂 Apipost IDEA插件怎么用_API_07


标签:插件,同步,配置文件,Apipost,配置,IDEA,API
From: https://blog.51cto.com/u_16129474/6686941

相关文章

  • 【辅助工具】IDEA使用
    IDEA使用快捷键快捷键alt+enter:代码错误智能提示alt+up:上个方法alt+down:下个方法alt+1:快速定位到项目窗口,还可边按键盘输文件名查找文件alt+F7:定位类,方法在哪儿有用到alt+7:文件结构图Ctrl类ctrl+tab:切换文件ctrlctrl:弹出一个框输入运行指令ctrl+e:展示最近修改......
  • idea显示左下角service
    展示效果: 解决方案:1.点击左下角这个按钮 2.点击蓝色英文,addservices3.找到众多模板中的springboot,点击即可原文章地址:https://blog.csdn.net/Hubery_sky/article/details/131644107?spm=1001.2014.3001.5501......
  • 【转载】欢迎使用园子的 vscode 插件
    欢迎使用园子的vscode插件【转载】欢迎使用园子的vscode插件-博客园团队-博客园(cnblogs.com)【转载】博客园团队   为了方便大家通过vscode编辑博文,我们做了一个小插件,插件名称是“博客园Cnblogs客户端”,插件列表中搜索“博客园”或者"cnblogs"可......
  • aardio桌面软件开发 简单,打包后文件小,支持 .net python 和 众多插件
    aardio编程语言-官网 aardio ......
  • SQ工具|0|ArcGIS插件的使用方式
    打开压缩包中的MLR.exe,选择一个输出路径,点击submmit,将生成的文件发我进行授权。①关闭所有正在运行的ArcMap,并打开一个新的ArcMap界面。②点击上方的自定义,选择自定义模式。③点击从文件添加④选择插件文件夹中的后缀为tlb的文件⑤点击打开,稍等片刻,在弹出的对话框中点击确......
  • Java实现浏览器端大文件分片上传插件
    ​ 我们平时经常做的是上传文件,上传文件夹与上传文件类似,但也有一些不同之处,这次做了上传文件夹就记录下以备后用。首先我们需要了解的是上传文件三要素:1.表单提交方式:post(get方式提交有大小限制,post没有)2.表单的enctype属性:必须设置为multipart/form-data.3.表单必须......
  • API管理不好做?来试试Apipost,前端、后端、测试,一个平台全搞定
    API是什么&API管理存在哪些问题API(ApplicationProgrammingInterface,应用程序接口)作为一系列预先定义的规则和约定,用于不同软件应用之间的通信,促进了系统间的互动和数据共享。在企业数字化转型的推进中,API管理变得越来越重要。然而,API管理过程中存在着一些困境,以下是其中的四个......
  • 如何实现jQuery插件select2利用ajax高效查询大数据列表(可搜索、可分页的具体操作步骤
    jQuery插件select2利用ajax高效查询大数据列表(可搜索、可分页)在Web开发中,当需要处理大量数据的列表时,通常需要考虑如何能够高效地进行搜索和分页。jQuery插件select2是一个强大的工具,可以帮助我们实现这一目标。本文将介绍如何使用select2插件利用ajax高效查询大数据列表,并提供......
  • 解决intellij idea spring boot 安装的具体操作步骤
    IntellijIDEASpringBoot安装指南简介IntellijIDEA是一款强大的Java集成开发环境(IDE),而SpringBoot是一种用于简化Spring应用程序开发的框架。本文将指导你如何在IntellijIDEA中安装和配置SpringBoot。安装步骤下面的表格展示了IntellijIDEASpringBoot安装的步骤及相应......
  • IDEA---- git 拉取项目
    GitBash拉取(Git下载安装略)方法一:鼠标右键单击,选择GitBashHere输入指令:gitclone+拉取的git地址,如下图所示:拉取到本地文件夹,然后IDEA导入项目: 方法二:IDEA直接拉取git上的项目,如下图所示:URL:输入克隆项目的地址  方法三:如下图所示:   ......