简介

Apifox是什么?
API 文档、API 调试、API Mock、API 自动化测试一体化协作平台,
Apifox能做什么?
Postman + Swagger + Mock + JMeter

创建项目

  1. 新建团队
    首先要新建团队,类似一个项目组示例项目->新建团队-团队名称
    在这里插入图片描述
  2. 新建项目
    新建团队后新建一个项目
    在这里插入图片描述
    填写项目名称,选择项目成员和权限,
  • 是否公开
    • 私有项目,仅对项目组成员开放,
    • 公开项目,对网络上所有人开发
      在这里插入图片描述
  1. 邀请成员
    选择成员/权限——>邀请成员,选择对应的方式邀请别人加入项目组,并赋予相应权限
    在这里插入图片描述

接口

  1. 新建接口
    在这里插入图片描述
  2. 填写参数
    在这里插入图片描述
  3. 智能导入响应格式
    在这里插入图片描述
    在这里插入图片描述
  4. 测试随机生成返回结果
    有一些字段如果是常用字段,可以返回一些对应的值,类似age、username、province等等
    在这里插入图片描述

项目概览

在线分享

类似于百度网盘,可以生成地址和密码,然后分享给别人访问
例如:

链接: https://www.apifox.cn/apidoc/shared-76e64bba-1679-4305-af9a-1bb0bd992a15
访问密码 : qRFV92IO

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

接口描述

接口描述不需要使用注解,会自动读取controller的多行注释

在这里插入图片描述

IDEA中使用apifox插件

先安装插件

在这里插入图片描述

创建团队创建项目

在这里插入图片描述

拿到token

1. 右上角头像点击,选择账号设置,
2. 弹出的窗口中左侧选择API访问令牌。
3. 选择新建,
4. 填写名称和期限,点击保存并生成令牌后,
5. 生成的令牌,记下来,IDEA的插件中要用。

在这里插入图片描述

配置idea的插件

在IDEA中安装了apifox的插件以后,setting中出现Apifox Helper项,选择Apifox设置,然后在API访问令牌这一项中,填入上一步中获取到的令牌,最底下,写上项目模块名:项目id,然后ok保存
在这里插入图片描述
项目id在apifox中,点击项目进来以后,项目设置-基本设置-项目id
在这里插入图片描述

接口信息导入apifox

要导入接口的项目上右键,如果是多模块,要导入哪个模块,就在哪个模块上面
在这里插入图片描述
选择Upload to Apifox,出现扫描信息,
在这里插入图片描述

扫描完成,就会出现在apifox的接口信息中,如果操作完,apifox里面没有,就右上角刷新一下,

多模块导入

  • 多模块的时候,要是想所有模块接口都导入在一起,就直接父模块右键Upload to Apifox
  • 多模块的时候,接口想要按照模块分开,apifox中就需要创建多个项目,每个项目有一个项目id,按照第四步的操作,配置对应的模块名和项目id
  • 如果第四步没有配置,会弹出提示框,让你输入对应的项目id,你输入的哪个项目id,接口信息就会刷新到对应的id。
    在这里插入图片描述
  • 如果你是A模块右键Upload to Apifox,但是你填的是B模块的项目id,就会把A模块的接口信息,刷新到B里面

更新接口

  • 模块更新,就在对应模块名右键Upload to Apifox
  • controller更新,对应controller右键Upload to Apifox,导入controller的所有接口。
  • 方法更新,在类中右键ApifoxHelper,Export API,然后选择想要更新的方法,回车键确认,可多选可单选
    在这里插入图片描述

apifox调用dubbo接口

  • 新建团队
    在这里插入图片描述

  • 新建项目
    在这里插入图片描述

  • 输入包名
    在这里插入图片描述

  • 新建服务输入接口类名
    在这里插入图片描述

  • 添加方法
    在这里插入图片描述

  • 参数如果是对象
    在这里插入图片描述

Logo

开放原子开发者工作坊旨在鼓励更多人参与开源活动,与志同道合的开发者们相互交流开发经验、分享开发心得、获取前沿技术趋势。工作坊有多种形式的开发者活动,如meetup、训练营等,主打技术交流,干货满满,真诚地邀请各位开发者共同参与!

更多推荐