快捷導(dǎo)航

Idea集成ApiFox插件及使用小結(jié)

更新時(shí)間：2024年11月19日 10:33:38 作者：Java白菜治

本文介紹了如何使用Apifox和IntelliJ IDEA插件來(lái)整理和生成接口文檔,包括配置Apifox和IntelliJ IDEA插件、代碼案例以及使用方法,感興趣的朋友跟隨小編一起看看吧

1.前言

最近公司在搞這個(gè)文檔,沒(méi)這些文檔甲方給不了錢,頭疼的很,要把之前的需求文檔啊,設(shè)計(jì)文檔啊,操作手冊(cè)啊,都統(tǒng)統(tǒng)的交上去,這不,一個(gè)文件一個(gè)文件的在趕項(xiàng)目,所以啊,開發(fā)之前,一定要先做好充足的準(zhǔn)備,后期一點(diǎn)都不慌,今天就先說(shuō)說(shuō)我負(fù)責(zé)的文檔吧,主要是整理開發(fā)的接口文檔,接口名稱,輸入數(shù)據(jù)和輸出數(shù)據(jù),也就是請(qǐng)求參數(shù)和響應(yīng)參數(shù),之前開發(fā)只為了趕進(jìn)度,接口都是自己維護(hù)自己的,沒(méi)有統(tǒng)一的,就算是自己的,有的寫了有的沒(méi)寫,寫了的還沒(méi)注釋等信息,所以基本還得再修改后才能弄到文檔里面,期間想了很多辦法,最中意的就是自動(dòng)更新文檔,這個(gè)最好,所以在這記錄一下
就算不寫穩(wěn)當(dāng)平時(shí)和前端聯(lián)調(diào)的時(shí)候會(huì)很方便,自己維護(hù)好后可以導(dǎo)出到公司的接口管理工具里面

2.使用

2.1.Apifox配置

2.1.1.新建團(tuán)隊(duì)

2.1.2.新建項(xiàng)目

2.1.3.設(shè)置令牌

點(diǎn)擊右上角頭像,找到賬號(hào)設(shè)置

復(fù)制下來(lái)令牌

2.2.Idea配置

2.2.1.Idea安裝ApiFox插件

2.2.2.設(shè)置令牌及項(xiàng)目

2.2.3.代碼案例

@link 這個(gè)注解是引用類的作用

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 {
    /**
     * 根據(jù)用戶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");
    }
}

Dto

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

VO

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

在Controller類中右鍵鼠標(biāo)，選擇Upload to Apifox即可(或者快捷鍵Alt+Shift+E)。