ApiFox接口文档的使用

前言

  • 我们都知道,现在业界基本上都是前后端分离的架构,前端人员和后端人员同步进行着自己的工作,那么前端人员怎么知道要调用后端哪些接口呢,这些接口的参数是什么呢,请求的方式又是什么呢,等等问题都需要前后端人员协调好,不可能做一个功能问一下吧,这显然是提高不了工作效率的,还可能因为传达信息不明确而做无用的工作,所以我们需要一个文档,来告诉前端开发人员到底有哪些接口,接口的参数是什么,请求方式是什么。
  • 但是写这样一个文档又是一件很费时间的事儿,所以ApiFox就能帮助我们生成需要的接口文档,只需要在接口上加上相应的注释,对代码0入侵,使用起来也超级方便。

APiFox创建接口文档

  • 【第一步】安装 Apifox IDEA 插件(Apifox Helper)
    File > Setting > Plugins ,搜索Apifox Helper ,点击install即可,下图是下载后的界面
    在这里插入图片描述
    下载成功后,在类中右键就会出现Apifox的标志
    在这里插入图片描述
    【第二步】配置访问令牌和项目id
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值