ShowDoc-工具-RunApi使用教程

一、介绍 runapi是一个以接口为核心的开发测试工具(功能上类似一个简化版的postman)。目前有客户端版(推荐,支持win和mac平台)和在线精简版 ,包

一、介绍
runapi是一个以接口为核心的开发测试工具(功能上类似一个简化版的postman)。目前有客户端版(推荐,支持win和mac平台)和在线精简版 ,包含接口测试/项目协作等功能。

二、客户端版本
Windows版
Mac版

在这里插入图片描述

三、数据说明
runapi的数据可以生成markdown格式,但不可逆,markdown数据很难再转换回来runapi。所以它无法跟showdoc原有数据互相转换。只是它们可以共用文档浏览/团队协作等功能。同时runapi生成的文档只能在runapi上编辑,不能在showdoc上编辑。

四、下载安装
请到官方下载:https://www.showdoc.com.cn/runapi?page_id=4758520094221537

五、使用
1、安装成功后请登录ShowDoc账号
在这里插入图片描述
2、创建项目文档
在这里插入图片描述
3、添加目录、新建项目等功能使用。
在这里插入图片描述
4、界面功能描述
在这里插入图片描述
5、接口调用和生成在线文档
在这里插入图片描述
6、查看在线文档
在这里插入图片描述
7、编辑和修改文档
在runapi生成的文档只能在runapi上编辑,编辑后再一次点击保存。线上就自动更新。

最后
官方地址:https://www.showdoc.com.cn/runapi?page_id=30291
各种代码写法可以参考MarkDown