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

2023年 7月 14日 51.3k 0

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

安装Apipost Helper

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

配置方法:

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

  • 在Apipost 「项目设置」>「对外能力」>「open API」中创建、复制 API-token、项目ID。
  • 进入IDEA设置界面 >「Apipost Config」 中填写 API-token、项目ID。
  • 使用方法

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

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

    示例:Test1/Test1.2,Test2

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

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

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

    相关文章

    JavaScript2024新功能:Object.groupBy、正则表达式v标志
    PHP trim 函数对多字节字符的使用和限制
    新函数 json_validate() 、randomizer 类扩展…20 个PHP 8.3 新特性全面解析
    使用HTMX为WordPress增效:如何在不使用复杂框架的情况下增强平台功能
    为React 19做准备:WordPress 6.6用户指南
    如何删除WordPress中的所有评论

    发布评论