Idea集成ApiFox插件及使用小结

 更新时间:2024年11月19日 10:33:38   作者:Java白菜治  
本文介绍了如何使用Apifox和IntelliJ IDEA插件来整理和生成接口文档,包括配置Apifox和IntelliJ IDEA插件、代码案例以及使用方法,感兴趣的朋友跟随小编一起看看吧

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");
    }
}

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类中右键鼠标,选择Upload to Apifox即可(或者快捷键Alt+Shift+E)。

3.效果

到此这篇关于Idea集成ApiFox插件的文章就介绍到这了,更多相关Idea ApiFox插件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • java 完全二叉树的构建与四种遍历方法示例

    java 完全二叉树的构建与四种遍历方法示例

    本篇文章主要介绍了java 完全二叉树的构建与四种遍历方法示例,具有一定的参考价值,感兴趣的小伙伴们可以参考一下。
    2017-03-03
  • Spring中的@EnableWebSecurity注解详解

    Spring中的@EnableWebSecurity注解详解

    这篇文章主要介绍了Spring中的@EnableWebSecurity注解详解,EnableWebSecurity注解是个组合注解,它的注解中,又使用了@EnableGlobalAuthentication注解,需要的朋友可以参考下
    2023-12-12
  • 浅析java volatitle 多线程问题

    浅析java volatitle 多线程问题

    Volatile修饰的成员变量在每次被线程访问时,都强迫从共享内存中重读该成员变量的值。而且,当成员变量发生变化时,强迫线程将变化值回写到共享内存
    2013-08-08
  • java Split 实现去除一个空格和多个空格

    java Split 实现去除一个空格和多个空格

    这篇文章主要介绍了java Split 实现去除一个空格和多个空格,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-10-10
  • 向Spring IOC 容器动态注册bean实现方式

    向Spring IOC 容器动态注册bean实现方式

    这篇文章主要为大家介绍了向Spring IOC 容器动态注册bean实现方式详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-07-07
  • spring boot启动时加载外部配置文件的方法

    spring boot启动时加载外部配置文件的方法

    这篇文章主要给大家介绍了关于spring boot启动时加载外部配置文件的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧。
    2018-02-02
  • SpringBoot集成ShedLock实现分布式定时任务的示例代码

    SpringBoot集成ShedLock实现分布式定时任务的示例代码

    ShedLock 是一个 Java 库,通常用于分布式系统中,确保定时任务(Scheduled Tasks)在集群环境下只被某一个实例执行一次,本文给大家介绍了SpringBoot集成ShedLock实现分布式定时任务的示例代码,需要的朋友可以参考下
    2024-12-12
  • Lombok 的@StandardException注解解析

    Lombok 的@StandardException注解解析

    @StandardException 是一个实验性的注解,添加到 Project Lombok 的 v__1.18.22 版本中,在本教程中,我们将使用 Lombok 的 @StandardException 注解自动生成异常类型类的构造函数,需要的朋友可以参考下
    2023-05-05
  • 详解Java的位运算

    详解Java的位运算

    这篇文章主要介绍了详解Java的位运算,程序中的所有数在计算机内存中都是以二进制的形式储存的。位运算就是直接对整数在内存中的二进制位进行操作,需要的朋友可以参考下
    2023-04-04
  • Redis工具类封装RedisUtils的使用示例

    Redis工具类封装RedisUtils的使用示例

    本文主要介绍了Redis工具类封装RedisUtils的使用示例,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-03-03

最新评论