Apikit 自学日记:导入、导出文档

news2024/10/6 18:18:46

一、导入API文档

功能入口:API管理应用 / 选中某个项目 / API文档菜单 / 点击“+ API”按钮旁的下拉按钮 / 选中“导入API”

Eolink提供一键导入已有API文档的功能,支持多种产品格式。常用于新项目创建后,需要对旧项目或旧软件内数据进行迁移的场景。

当前支持的产品格式如下:

支持的产品格式支持度导入文件的后缀名
Eolinker API 研发管理完全支持.json
Postman V2.1支持导入API基础信息,超过10级分组的API数据将不会被导入.json
Swagger V2支持导入API基础信息.json
Swagger V3支持导入API基础信息.json
JMeter支持导入API基础信息.jmx
YApi支持导入API基础信息.json
ApiPost支持导入API基础信息.md
apiDoc支持导入API基础信息.json/.js
Apifox支持导入API基础信息json
HAR支持导入API基础信息
RAP支持导入API基础信息.json
RAP2支持导入API基础信息.json
PROTO2支持导入API基础信息.proto
PROTO3支持导入API基础信息.proto

1、按以上的功能入口路径进入导入API窗口。

 

2、选择对应的导入数据类型格式。

 

3、配置导入规则

 

选项说明

1)将 API 导入到以下分组:选择对应的API分组

2)将新生成 API 文档状态设置为:可以将导入API文档设置对应状态

3)将发生变更的 API 文档状态设置为:如已发生变更状态的API文档,可以更新指定的文档状态

4)将新生成的或发生变更的 API 文档的版本号设置为:可以将导入API文档设置指定的API版本号

4、等待导入任务完成

设置好导入配置规则后 点击确定就会显示成功提示 并且右侧栏显示我的任务队列进行中 当状态显示完成就导入成功了 如图

 

最后刷新页面就可以看到导入的API数据了 如图

 

二、导出文档

导出API文档

您可以将项目的API文档导出为多种离线格式,方便分享给团队以外的人。

导出方式分为3种:

  • 导出项目内所有API文档

  • 导出分组内的API文档

  • 导出指定的API文档

导出项目内所有API文档

1、在左侧栏的项目管理中,选择二级菜单项目设置,底部其他操作中点击“导出项目”。

 

导出项目支持以下格式:

  • Eolink Apikit 项目数据

  • Eolink Apikit API相关数据

  • HTML

  • Word

  • PDF

  • Excel

  • Markdown

  • Swagger JSON

  • Swagger YAML

Eolink Apikit 项目数据 和Eolink Apikit API相关数据的差异在于,前者出来包含API相关数据外额外包含了状态码、项目文档、环境、数据结构等项目级公共数据,后者仅支持API文档、测试用例、高级Mock等数据。

2、第一选项Eolink 项目数据(.json) 是将当前项目所有API数据进行导出 点击确定就可以进行导出操作 如图

 

3、其他格式会显示下一步按钮 点击下一步 跳转到选择导出的内容

 

导出分组内的API文档

1、在左侧栏的API点击,选择需要导入的分组,点击下拉框选择导出API

 

导出分组支持以下格式:

  • Eolink Apikit

  • Word

  • PDF

  • Excel

  • Markdown

注意:免费版产品仅支持导出 Eolink Apikit 格式,其余格式需要升级到专业版产品

2、点击下一步 跳转到选择导出的内容 如图

 

导出指定的API文档

1、在左侧栏的API点击,选择需要导入的分组或点击所有API,点击右侧API列表标签页下的批量操作按钮 如图

 

2、选中需要导出的API数据,点击导出按钮 如图

 

导出指点API文档支持以下格式:

  • Eolink Apikit

  • Word

  • PDF

  • Excel

  • Markdown

注意:基础版产品仅支持导出 Eolink Apikit 格式,其余格式需要升级到专业版或企业版产品

3、点击下一步 跳转到选择导出的内容

 

选择导出的内容

1、 如果是选择导出项目内所有API文档方式 则左侧栏显示筛选API分组 右侧栏显示选择筛选条件 如图

 

2、 如果是选择导出分组内API文档方式 则显示选择筛选条件 如图

 

3、如果是导出指定的API文档,则显示筛选条件,并且只显示额外导出内容如图

 

筛选字段说明

1)筛选API标签:可以筛选指定的API标签的数据

2)筛选API标记:可以筛选有星标和无星标的API数据

3)筛选API状态:可以筛选指定的API状态

4)额外导出内容:可以筛选API返回示例和API详细说明等信息 (execl和Swagger不支持该选项)

5)导出环境:可以导出指定的项目环境(Eolink 不支持改选项)

最后步骤

1、点击确定后 显示成功提示 并且右侧栏显示我的任务队列状态为进行中 成功后就可以点击下载到本地了

 

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/683637.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

认识设计组件帮助测试,以提高产品用户体验

一、控制元素 1、活动指示器——应与背景想协调,用于持续时间不明的进程,单一元素不显示,大于1个显示 2、加载控件——同一个专区页面,加载样式统一 3、页码控制器——原点最好控制在5点内,左右滑动,点击原…

OpenCL编程指南-5.5图像读、写函数

读图像 OpenCL GPU设备有专用硬件来读、写图像。OpenCL C图像读、写函数允许开发人员充分利用这个专用硬件。OpenCL 中的图像支持是可选的。要了解一个设备是否支持图像,可以使用clGetDeviceInfo API查询CL_DEVICE_IMAGE_SUPPORT属性。 需要说明的是&#xff0…

c4d+AI+PS设计广告展示架/销售柜台/展示盒子的建议

1、首先做出我标识出来的样子,这里称作A面。(可用软件:PS、AI、cdr等) 2、制作用于展示盒A面PNG图片(PS来掏空空白处用于描边)。 操作:按需求缩小图片,载入选区,新建图层…

three.js标准网格材质(MeshStandardMaterial)光照、粗糙度、金属度、法线属性介绍

如上图,在前面的章节中我们通过设置物体的纹理和材质实现了一个3d的立体门框的效果 完整代码如下: import * as THREE from "three"; // 导入轨道控制器 import { OrbitControls } from "three/examples/jsm/controls/OrbitControls&quo…

新媒体运营工作总结

新媒体运营工作总结篇1 一、大力提升新媒体平台的关注度。在当前掩盖全校60%的同学的基础上,进一步提高掩盖率,争取在未来一年中到达90%以上。为了增强平台与受众的互动与交流,吸引同学们的关注,可以展开更多同学们喜闻乐见的线上…

macOS FreeBSD 如何刷新 DNS 缓存

macOS FreeBSD 如何刷新 DNS 缓存 全文:如何刷新 DNS 缓存 (macOS, Linux, Windows) Unix Linux Windows 如何刷新 DNS 缓存 (macOS, FreeBSD, RHEL, CentOS, Debian, Ubuntu, Windows) 请访问原文链接:https://sysin.org/blog/how-to-flush-dns-cach…

(动态规划) 5. 最长回文子串 ——【Leetcode每日一题】

❓ 5. 最长回文子串 难度:中等 给你一个字符串 s,找到 s 中最长的回文子串。 如果字符串的反序与原始字符串相同,则该字符串称为回文字符串。 示例 1: 输入:s “babad” 输出:“bab” 解释&#xff1a…

Pytest+Webdriver+Alluer的UI自动化测试框架

作为web自动化的入门学习,搭建框架练习下 一、熟悉项目的测试框架的整体目录 二、 PIP安装完所需框架 1、编写main.py import pytestif __name__ __main__:#pytest.main() # 遍历相同目录下的所以test开头的用例#生成测试报告 #一次执行所有接口测试用例&…

【消费战略方法论】3W消费战略作业方法

3W消费战略 以消费者为核心导向的 品牌战略 品牌本质上属于消费者,消费者是品牌战略的核心。所有品牌工作都应把握一个标准,即是否围绕着消费者,是否对消费者有价值。一切的品牌战略、策略、创意、营销等工作都应该是为了“消费者”而设…

【Java|多线程与高并发】定时器(Timer)详解

文章目录 1. 前言2. 定时器的基本使用3. 实现定时器4. 优化上述的定时器代码5. 总结 1. 前言 在Java中,定时器Timer类是用于执行定时任务的工具类。它允许你安排一个任务在未来的某个时间点执行,或者以固定的时间间隔重复执行。 在服务器开发中,客户端向…

原型模式(Prototype)

定义 原型是一种创建型设计模式,使你能够复制已有对象,而又无需使代码依赖它们所属的类。 别名 克隆(Clone)。 前言 1. 问题 如果你有一个对象,并希望生成与其完全相同的一个复制品,你该如何实现呢&a…

基于工业智能网关的设备运维管理平台有何功能?

工业物联网平台作为监控工业设备和工业环境的智能应用,整合边缘和云端的数据优势,在制造业领域得到越来越丰富的应用。 在工业制造生产过程中,常常分为人、机、料、法、环等五大要素,其中机器设备的安全稳定运行时保证工厂生产效…

58同城AI Lab在WeNet中开源GPU热词增强功能

01 前言 端到端语音识别系统在足够多数据上训练后,往往能达到不错的识别效果,然而在实际应用场景中,对于不常见的专有名词,例如人名、产品名、小区名等,往往容易识别错误,此类问题需要快速修复&#xff0c…

DNS是什么?DNS的工作流程

79. DNS是什么? DNS(Domain Name System)是一种用于将域名解析为相应IP地址的分布式命名系统,了解DNS对于理解域名解析原理和优化网络请求非常重要。本篇文章将介绍DNS的概念、工作原理以及在前端开发中的应用,帮助前…

正则表达式-捕获组,命名捕获组,非捕获组

正则表达式的作用 测试目标字符串是否符合规则 返回true/false按照规则从目标字符串提取内容 返回匹配的数组 在线测试工具 regex101: build, test, and debug regexRegular expression tester with syntax highlighting, explanation, cheat sheet for PHP/PCRE, Python, …

java适配达梦数据库

目录 一、数据库安装 二、数据库可视化工具 三、数据迁移 四、工程适配 新增maven依赖 配置文件修改 基于flyway的数据库版本管理 五、注意事项 一、数据库安装 官方文档:安装前准备 | 达梦技术文档 这里有一个点需要注意,如果你之前的数据库或…

【Java高级语法】(十六)方法引用:掌握Java中的方法引用,简化代码的实用指南~

Java高级语法详解之方法引用 1️⃣ 概念2️⃣ 优势和缺点3️⃣ 使用3.1 语法形式3.2 案例 4️⃣ 应用场景5️⃣ 注意事项🌾 总结 1️⃣ 概念 方法引用是Java编程语言中的一个重要特性,它首次出现在Java 8版本中。这一特性旨在简化函数式编程中使用Lambd…

【博客675】prometheus生产上易犯的错误

prometheus生产上易犯的错误 Mistake 1: Cardinality bombs 这是每个人在开始使用 Prometheus 时至少会遇到一次的经典陷阱。一旦您发现 Prometheus 基于标签的数据模型的有用性,您可能会想按各种有用的标签维度来拆分指标,直到您创建的时间序列超出 P…

【QT】枚举用到的宏详解:Q_ENUM,Q_FLAG,Q_DECLARE_FLAGS,Q_DECLARE_OPERATORS_FOR_FLAGS

目录 1. Q_ENUM宏 与 QMetaEnum类1.1 Q_ENUM宏的作用1.2 使用Q_ENUM注意的问题1.3 在写有关枚举的代码时,我们可能遇到这种情况:需要用到枚举的字符串,该怎么办?1.4 下面通过一段简单的代码来说明Q_ENUM的作用 2. Q_FLAG宏2.1 Q_F…

【SpringMVC】| 拦截器(含源码分析)

目录 拦截器 1. 拦截器的介绍 2. 拦截器的三个抽象方法 3. 拦截器的使用 4. 多个拦截器的执行顺序 Java核心技术大会 文末福利(Java核心技术卷) 拦截器 拦截器能拦截请求,前面学习的过滤器也能拦截请求,那两者有什么区别…