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插件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • mybatis高级映射一对多查询实现代码

    mybatis高级映射一对多查询实现代码

    本篇文章主要介绍了mybatis高级映射一对多查询实现代码,具有一定的参考价值,感兴趣的小伙伴们可以参考一下。
    2017-04-04
  • IntelliJ IDEA失焦自动重启服务的解决方法

    IntelliJ IDEA失焦自动重启服务的解决方法

    在使用 IntelliJ IDEA运行 SpringBoot 项目时,你可能会遇到一个令人困扰的问题,一旦你的鼠标指针离开当前IDE窗口,点击其他位置时, IDE 窗口会失去焦点,你的 SpringBoot 服务就会自动重启,所以本文给大家介绍了IntelliJ IDEA失焦自动重启服务的解决方法
    2023-10-10
  • 使用Java获取Json中的数据简单示例

    使用Java获取Json中的数据简单示例

    开发过程中经常会遇到json数据的处理,而单独对json数据进行增删改并不方便,下面这篇文章主要给大家介绍了关于使用Java获取Json中的数据,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-04-04
  • 教你使用java实现去除各种空格

    教你使用java实现去除各种空格

    本文给大家汇总介绍了5种java中去除空格的方法,分别是String.trim()、str.replace(" ", "");、replaceAll(" +","");以及自定义的remove函数,非常的简单实用,需要的小伙伴可以参考下。
    2015-03-03
  • 启动springboot项目时报错:无法访问org.springframework.web.bind.annotation.GetMapping …具有错误的版本 61.0,应为52.0​的解决方案

    启动springboot项目时报错:无法访问org.springframework.web.bind.annotatio

    这篇文章给大家分享了启动springboot项目时报错:​无法访问org.springframework.web.bind.annotation.GetMapping …具有错误的版本 61.0,应为52.0​的解决方案,文中通过图文介绍的非常详细,需要的朋友可以参考下
    2023-10-10
  • Java编程Socket实现多个客户端连接同一个服务端代码

    Java编程Socket实现多个客户端连接同一个服务端代码

    这篇文章主要介绍了Java编程Socket实现多个客户端连接同一个服务端代码,具有一定参考价值,需要的朋友可以了解下。
    2017-11-11
  • Java高级之虚拟机加载机制的实例讲解

    Java高级之虚拟机加载机制的实例讲解

    下面小编就为大家分享一篇Java高级之虚拟机加载机制的实例讲解,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2017-12-12
  • Java日常练习题,每天进步一点点(27)

    Java日常练习题,每天进步一点点(27)

    下面小编就为大家带来一篇Java基础的几道练习题(分享)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧,希望可以帮到你
    2021-07-07
  • 基于断点续传下载原理的实现

    基于断点续传下载原理的实现

    下面小编就为大家带来一篇基于断点续传下载原理的实现。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-09-09
  • 详解Java 中的嵌套类与内部类

    详解Java 中的嵌套类与内部类

    这篇文章主要介绍了详解Java 中的嵌套类与内部类的相关资料,希望通过本文大家能掌握Java 嵌套类与内部类的使用方法,需要的朋友可以参考下
    2017-09-09

最新评论