使用yapi工具编辑接口文档

简介: 使用yapi工具编辑接口文档


image.png

相对于swagger来说,yapi页面更加美观,使用上功能也更多了一些,所以操作也相对复杂,上文安装完

yapi后,本文将介绍如何使用yapi。

1.建立文档地址

1.新建分组

在多组同时使用时,可以按照小组对文档进行分类。

image.png

2.在分组中建立项目

在小组内新建项目文件夹。

image.png

3.进入项目后添加分类

在项目中按照业务类别新建分组。

image.png

2.编写接口文档

在编写接口文档的过程中,有四种方式。分别为手动编写,从postman导入,从swagger导入,通过idea生成。这样大大丰富了在日常使用中的灵活程度。下文将一一介绍。

1.手动编写

这种方式就是手动在系统中填写,比价繁琐。

image.png

在编辑中手动填写。

image.png

2.导入postman文档

1.导出文档

首先从postman中导出json文档。

image.png

注意,这里需要选择1.0选项。

image.png

2.导入文档

导入上文的json文件。

image.png

3.使用swagger导入

我们也可以选择同步swagger的文档,首先选择同步模式 。url为swagger地址 例 http://ip:8001/system/v2/api-docs。

image.png

当同步完成后,可以在页面中看到已经导入的接口文档。

4.使用idea插件

同时也可以连接idea通过配置生成接口文档。

1.安装插件

image.png

2.获取token

每个项目都有一个token,所以多项目的token是不同的。

image.png

3.在idea中配置

image.png

按照说明配置即可。

4.生成

在接口上点击idea-yapi即可生成。

image.png


相关文章
|
NoSQL JavaScript 数据可视化
告别swagger,加强版接口文档yapi工具安装
告别swagger,加强版接口文档yapi工具安装
161 0
告别swagger,加强版接口文档yapi工具安装
|
NoSQL Cloud Native 数据可视化
云原生之使用Docker部署YApi接口管理服务平台
云原生之使用Docker部署YApi接口管理服务平台
607 0
云原生之使用Docker部署YApi接口管理服务平台
|
6月前
|
数据可视化 JavaScript NoSQL
搭建接口平台YApi详解(含搭建node环境)
搭建接口平台YApi详解(含搭建node环境)
194 0
|
Web App开发 JSON 安全
【漏洞复现】Yapi接口管理平台远程代码执行漏洞
Yapi接口管理平台远程代码执行漏洞,攻击者可通过特定Payload对目标实施恶意攻击,获取敏感信息,操控服务器指令。
615 1
|
Web App开发 JSON 前端开发
YApi 官网说明文档-接口操作
为方便和前端, 节省沟通成本, 编写接口文档非常有比较 使用过swagger, 觉得入侵性太大. POST又感觉和项目结合的不太紧密. 所以一直在寻找 新的接口阅读/生成/测试工具. 下面介绍一下YApi.
1738 0
YApi 官网说明文档-接口操作
|
前端开发 数据可视化 机器人
基于YAPI的接口工作流
基于YAPI的接口工作流
475 0
基于YAPI的接口工作流
|
存储 NoSQL JavaScript
Linux下快速搭建YApi接口管理平台
目录 一、序言 二、安装Node 1、安装nvm 2、使用兼容的Node版本 二、安装MongoDB 1、下载MongoDB 2、配置MongoDB 三、安装YApi 四、安装PM2管理Node服务 五、登录YApi后台
Linux下快速搭建YApi接口管理平台
|
数据可视化 数据管理 测试技术
02 提效工具之yapi接口生成
02 提效工具之yapi接口生成
|
XML JSON 前端开发
开源的YAPI外还有哪些免费的接口工具?
API 管理这个话题近些年听到的频次越来越多,这本质上是个 web 领域的发展有关,也和开发协作方式有关--前后端分离代替了全栈工程师 hold all 的局面,强调的更多的是 API 复用、分工和协作细化。 API 管理的重要性不言而喻,每家公司随着业务的发展,多多少少都会涉及到;从开源社区的产品到国内各类商业化产品,可以看到大家对于 API 管理是越来越重视的。
|
Kubernetes 数据可视化 测试技术
可视化接口管理平台 YApi,让你轻松搞定 API 的管理问题
高效、易用、功能强大的可视化接口管理平台 YApi,让我们能轻松帮助我们搞定 API 的管理问题。
754 1