当前位置：首页 > news >正文

Idea集成ApiFox插件

news 2024/11/22 20:36:18

文章目录

- 1.前言
- 2.使用
- - 2.1.Apifox配置
  - - 2.1.1.新建团队
    - 2.1.2.新建项目
    - 2.1.3.设置令牌
  - 2.2.Idea配置
  - - 2.2.1.Idea安装ApiFox插件
    - 2.2.2.设置令牌及项目
    - 2.2.3.代码案例
- 3.效果

1.前言

最近公司在搞这个文档,没这些文档甲方给不了钱,头疼的很,要把之前的需求文档啊,设计文档啊,操作手册啊,都统统的交上去,这不,一个文件一个文件的在赶项目,所以啊,开发之前,一定要先做好充足的准备,后期一点都不慌,今天就先说说我负责的文档吧,主要是整理开发的接口文档,接口名称,输入数据和输出数据,也就是请求参数和响应参数,之前开发只为了赶进度,接口都是自己维护自己的,没有统一的,就算是自己的,有的写了有的没写,写了的还没注释等信息,所以基本还得再修改后才能弄到文档里面,期间想了很多办法,最中意的就是自动更新文档,这个最好,所以在这记录一下
就算不写稳当平时和前端联调的时候会很方便,自己维护好后可以导出到公司的接口管理工具里面

2.使用

2.1.Apifox配置

2.1.1.新建团队

在这里插入图片描述

2.1.2.新建项目

在这里插入图片描述

2.1.3.设置令牌

点击右上角头像,找到账号设置
在这里插入图片描述

复制下来令牌

2.2.Idea配置

2.2.1.Idea安装ApiFox插件

在这里插入图片描述

2.2.2.设置令牌及项目

在这里插入图片描述

2.2.3.代码案例

@link 这个注解是引用类的作用

Controller

import com.baicaizhi.dto.UserDto;
import com.baicaizhi.vo.UserVO;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.annotations.Param;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;import java.util.HashMap;/*** 用户接口* @author Administrator*/
@RestController
@Slf4j
public class UserController {/*** 根据用户id获取用户id* @param id 用户id* @return {@link }*/@GetMapping("/find/{id}")public Object findById(@Param("id") Long id){return new HashMap<>().put("userId",id);}/*** 获取用户信息1* @return {@link UserVO}*/@PostMapping("getUser1")public Object getUser1(){return new UserVO().setIp("127.0.0.1");}/*** 获取用户信息2* @param user  {@link  UserVO}* @return {@link  UserVO}*/@PostMapping("/getUser2")public Object getUser2(@RequestBody UserDto user){return new UserVO().setIp("127.0.0.1");}}

 import lombok.Data;
import lombok.experimental.Accessors;/*** 用户信息* @author Administrator*/
@Data
@Accessors(chain = true)
public class UserDto {/*** 性别*/private Integer sex;}

import lombok.Data;
import lombok.experimental.Accessors;/*** 用户信息* @author Administrator*/
@Data
@Accessors(chain = true)
public class UserVO {/*** ip地址*/String ip;
}