首页 > 其他分享 >Apifox入门

Apifox入门

时间:2023-01-14 20:11:17浏览次数:69  
标签:插件 入门 请求 接口 文档 Apifox pm

前言

本篇博客意在简化官方文档,提炼出使用Apifox必要的一些知识,如果时间充裕,请完整阅读官方文档

1.简介

国产版的postman,目前团队人数不设上限,不收费。这也是启用postman使用apifox的原因。

2.安装

官网

3.创建团队

我的团队-新建团队。

团队创建完成之后,可以在右侧进行人员的管理和团队项目的管理。

4.项目简介

项目由4部分组成:项目概览、接口、数据模型、快捷请求。

平常主要使用的是接口。

5.接口使用

可以请求接口,同时也是一个完善的接口文档,接口下的用例可以用作示例。你可以给每个接口都定义一个状态和负责人。

配合环境变量可以做到只切换环境就可以请求不同源服务的效果。

6.文档手动美化

在用插件生成文档之后,有些地方不尽如人意,可以手动美化。选择文档-->修改文档。

还可以生成用例,运行-->保存为用例。

返回结果可以提取到响应定义和响应示例。

7.脚本使用

最简单的使用就是获取一些数据并保存在变量中,以登录为例,首先请求验证码接口,获取到验证码,拿到验证码,再请求登录接口,获取token,保存在环境变量中,每个接口都会带上token进行请求。

脚本如下:

// 将接口返回数据,封装成自己需要的结构
var data = {
    response: pm.response.json()
}
var uuid = pm.response.json().data.uuid;
// html 模板字符
var template = `<html><img src="data:image/jpg;base64,{{response.data.img}}" /></html>`;
// 设置 visualizer 数据。传模板、解析对象。
pm.visualizer.set(template, data);
pm.globals.set("captcha-key", uuid);

8.IDEA插件生成接口

IDEA插件市场搜索安装Apifox Uploader。详细用法见:官方文档

插件的使用需要获取访问令牌(自己生成)和项目ID,然后在插件中进行配置。
目前插件存在许多的问题,但是可以满足基本的生成文档并调试的需求,基于目前版本,以下是我的配置示例:

# 模块项目ID配置
hil-woss-duty:2135023,值班管理系统
hil-woss-duty-api:2135023,值班管理系统

格式为:模块名:项目ID,文件夹名

目前插件存在问题,无法从@ApiModelProperty获取字段的中文名,所以需要加注释的方式来实现。

    /**
     * 所属部门id
     */
    @ApiModelProperty(value = "所属部门id")
    private String orgId;

文件夹名也是取的controller的注释,支持多级文件夹,用/分割。

/**
 * 基础管理/值班管理
 */
 public class BaseController {}

api取的是@ApiOperation注释的方法。

插件还支持自定义,详情请见官方文档

标签:插件,入门,请求,接口,文档,Apifox,pm
From: https://www.cnblogs.com/datangguanjunhou/p/17052466.html

相关文章

  • SpringBoot——核心原理入门
    SpringBoot概述BuildAnythingwithSpringBoot:**SpringBootisthestartingpointforbuildingallSpring-basedapplications.SpringBootisdesignedtoget......
  • Web安全入门与靶场实战(5)- 安装DVWA
    搭建好LAMP环境之后,我们再继续通过安装一个真实的网站,从而更加真切地了解网站的整体架构,这里我们要安装的网站是DVWA。DVWA(DamnVulnerableWebApp)是用PHP+MySQL编写的一个......
  • QML入门教程(1): Qt Quick与QML介绍
    1什么是QtQucik?         QtQuick是QtSDK4.7中引入的一种新的界面开发框架,使用QtQuick,你可以快速、轻松地创建供移动和嵌入式设备使用的动态触摸式......
  • leetcode算法入门 Day5 双指针(四)
    876.链表的中间结点给定一个头结点为head的非空单链表,返回链表的中间结点。如果有两个中间结点,则返回第二个中间结点。输入:[1,2,3,4,5]输出:此列表中的结点3(序......
  • 鸿蒙系统应用开发之入门解说
    Hi,欢迎大家在有空的时候做客【江涛学编程】,这里是2023年的第11篇原创文章,同学,我们又见面啦,今天我们继续聊下上一期讲的那个话题------鸿蒙系统应用开发入门解说老规矩,......
  • 230113_50_SpringBoot入门
    EnableAutoConfiguration详解​ SpringBoot可以实现自动配置;@EnableAutoConfiguration注解用于告知springboot开启自动配置功能,这样自动配置才能生效。@AutoConfigura......
  • jQuery入门
    jQuery入门1、基础语法jQuery语法是通过选取HTML元素,并对选取的元素执行某些操作。基础语法:$(selector).action()美元符号定义jQuery选择符(selector)"查询"和"查......
  • 03.JAVA入门
    Java入门一、Java的特性和优势特性优势:简单性、面向对象、可移植性、高性能、分布式、动态性、多线程、安全性、健壮性二、JDKJREJVMJVM:JavaVirtualMachin......
  • 【深入浅出Seata原理及实战】「入门基础专题」探索Seata服务的AT模式下的分布式开发实
    承接上文上一篇文章说到了Seata为用户提供了AT、TCC、SAGA和XA事务模式,为用户打造一站式的分布式解决方案。那么接下来我们将要针对于AT模式下进行分布式事务开发的......
  • 【深入浅出Seata原理及实战】「入门基础专题」探索Seata服务的AT模式下的分布式开发实
    承接上文上一篇文章说到了Seata为用户提供了AT、TCC、SAGA和XA事务模式,为用户打造一站式的分布式解决方案。那么接下来我们将要针对于AT模式下进行分布式事务开发的原......