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+OpenCV实现人脸检测并自动拍照

    Java+OpenCV实现人脸检测并自动拍照

    这篇文章主要为大家详细介绍了Java+OpenCV实现人脸检测,并调用笔记本摄像头实时抓拍,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-07-07
  • spring cloud之eureka高可用集群和服务分区解析

    spring cloud之eureka高可用集群和服务分区解析

    这篇文章主要介绍了spring cloud之eureka高可用集群和服务分区解析,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-03-03
  • Spring boot从安装到交互功能实现零基础全程详解

    Spring boot从安装到交互功能实现零基础全程详解

    这篇文章主要介绍了Spring boot从安装到交互功能得实现全程详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-07-07
  • mybatis-plus使用@EnumValue处理枚举类型的示例代码

    mybatis-plus使用@EnumValue处理枚举类型的示例代码

    这篇文章主要介绍了mybatis-plus使用@EnumValue处理枚举类型的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-09-09
  • SpringMVC如何获取表单数据(radio和checkbox)

    SpringMVC如何获取表单数据(radio和checkbox)

    这篇文章主要介绍了SpringMVC如何获取表单数据(radio和checkbox)的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • springMVC返回复杂的json格式数据方法

    springMVC返回复杂的json格式数据方法

    下面小编就为大家分享一篇springMVC返回复杂的json格式数据方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-03-03
  • 解决@Cacheable在同一个类中方法调用不起作用的问题

    解决@Cacheable在同一个类中方法调用不起作用的问题

    这篇文章主要介绍了解决@Cacheable在同一个类中方法调用不起作用的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • java导出csv方法实现讲解

    java导出csv方法实现讲解

    这篇文章主要介绍了java导出csv的方法,客户要求在项目中有导出CSV文件的功能,并且给出了如何在不知道如何在不知道对象类型(没有应用泛型)的List中如何得到对象的属性值,下面就详细说下这个功能是如何实现的
    2013-12-12
  • springboot集成sensitive-word实现敏感词过滤的两种方案

    springboot集成sensitive-word实现敏感词过滤的两种方案

    敏感词过滤通常是指从文本中检测并移除或替换掉被认为是不适当、冒犯性或违反特定社区准则的词汇,这篇文章主要介绍了springboot集成sensitive-word实现敏感词过滤,需要的朋友可以参考下
    2024-08-08
  • 巧用Spring中的@Order进行排序

    巧用Spring中的@Order进行排序

    这篇文章主要介绍了巧用Spring中的@Order进行排序,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-08-08

最新评论