YAPI介绍

前后台分离开发中,我们前后台开发人员都需要遵循接口文档,所以接下来我们介绍一款撰写接口文档的平台。

YApi 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。

其官网地址:YApi-高效、易用、功能强大的可视化接口管理平台

YApi主要提供了2个功能:

  • API接口管理:根据需求撰写接口,包括接口的地址,参数,响应等等信息。

  • Mock服务:模拟真实接口,生成接口的模拟测试数据,用于前端的测试。

接口文档管理

接下来我们演示一下YApi是如何管理接口文档的。

首先我们登录YAPI的官网,然后使用github或者百度账号登录,没有的话去注册一个,如下图所示:

登录进去后,在个人空间中,选择项目列表->添加测试项目,效果如图所示:

然后点击创建的项目,进入到项目中,紧接着先添加接口的分类,如下图所示

然后我们选择当前创建的分类,创建接口信息,如下图所示:

紧接着,我们来到接口的编辑界面,对接口做生层次的定制,例如:接口的参数,接口的返回值等等,效果图下图所示:

添加接口的请求参数,如下图所示: 添加接口的返回值,如下图所示:

然后保存上述设置,紧接着我们可以来到接口的预览界面,查询接口的信息,其效果如下图所示:篇幅有限,只截取部分

最后,我们还可以设置接口的mock信息,

来到接口的Mock设置窗口,如下图所示:

紧接着我们来到接口的预览界面,直接点击Mock地址,如下图所示:

我们发现浏览器直接打开,并返回如下数据:

如上步骤就是YAPI接口平台中对于接口的配置步骤

YAPI -- API管理平台相关推荐

  1. Centos7 安装超牛逼的api管理平台yapi

    yapi 是什么 YApi 是高效.易用.功能强大的 api 管理平台,旨在为开发.产品.测试人员提供更优雅的接口管理服务.提供了 api 文档管理,api 数据 模拟(Mock),调试和自动化测试 ...

  2. 高效、易用、功能强大的 api 管理平台(内附彩蛋)

    前言导读 实际环境的需求可以说是:只有你没想到,没有实现不了的,征对于目前实际开发.测试.生产等环境中,需要用到各类的接口可达几十.甚至上百个,因此,必须需要一个统一管理的工具平台来统一管理这类接口, ...

  3. yapi 接口管理平台手册

    文章目录 前言 背景.现状.意义 mock测试 yapi 基于项目的管理 API接口管理 mock 服务器 使用 服务端使用路径 客户端使用路径 参考资料 前言 ​ 本篇旨在让相关开发人员理解引入 y ...

  4. YApi接口管理平台远程代码执行漏洞(含批量POC)

    0x00简介 YAPI是由去哪儿网移动架构组(简称YMFE,一群由FE.iOS和Android工程师共同组成的最具想象力.创造力和影响力的大前端团队)开发的可视化接口管理工具,是一个可本地部署的.打通 ...

  5. 搭建YApi接口管理平台+IDEA插件easyYapi一键生成接口动态发布到YApi平台

    文章目录 一.简介 二.YApi搭建 1.准备 2.可视化部署 3.浏览器访问 4.新建项目 5.获取项目的token 三.IDEA插件easyYapi 1.安装easyYapi 2.配置连接YApi ...

  6. API管理工具对比,制定您的API管理平台

    有一定工作年限的人一定会接触过通过word文档或者wiki的方式来进行接口对接交流的介质.后来为了方便协作修改接口,又逐渐的开始有人通过markdown文档,提交到版本管理系统的方式来编写接口. 后来 ...

  7. API管理平台,管理企业所有API资产

    RestCloud API管理平台与企业级API网关相互配合,管理企业所有API资产.API开发商.API消费者.构建企业统一的接口管理平台,完成整个API的全生命周期管理.API管理平台为每个开发商 ...

  8. WormHole是一个简单、易用的api管理平台,支持dubbo服务调用

    WormHole服务网关管理平台 相关快速链接 管理台操作说明 C端对接网关及签名说明 回调接口使用说明 多环境配置使用说明 网关错误码说明 WormHole更新说明 配置好即可运行 GitHub地址 ...

  9. API战略中台的正确落地方式:构建高效的“API管理平台”

    白山云科技 "一个组织的API战略应当是该组织数字化战略的重要支撑,并在其中占有相当大的比例." --Gartner分析师Paolo Malinverno, Mark O'Neil ...

最新文章

  1. 谁再说不熟悉Linux命令,就把这个给他扔过去!
  2. 剑指offer(26-33题)详解
  3. CYQ.Data V5 从入门到放弃ORM系列:教程 - MAction类使用
  4. Linux 中识别 USB 设备名字的 4 种方法
  5. 关于 SAP 电商云 Spartacus UI 访问 b2b site 的权限问题
  6. HTML+CSS+JS实现 ❤️圆圈倒计时间❤️
  7. Kinect学习笔记(五)——更专业的深度图
  8. 媲美专业相机? 看看华为P40带来的影像新突破!
  9. php 写博客教程,最近写了一个博客程序: QuickBlog PHP 开源的一文多发系统
  10. 数据治理(五):元数据管理
  11. 教你如何用python获得中国气象数据网的API数据并且导入数据库(附源码)
  12. 智能烟感与物联网卡可以了解一波
  13. 贪心算法之猴子吃香蕉(Monkeys and Bananas)
  14. js实现电子签名功能
  15. 嵌入式数据库和数据库服务器的区别
  16. 《图像处理实例》 之 二值图像分割
  17. notepad++ 同时搜索多个关键字
  18. ODBC连接达梦数据库
  19. C#时间显示格式(12小时制VS24小时制)
  20. tar -d 选项 比较归档文件与文件系统中的内容

热门文章

  1. java与模式 之,《java与模式》学习之状态模式
  2. 前端使用谷歌打开钉钉的H5页面开发地址
  3. java面试宝典(综合知识)
  4. python 玩玩乐 - moviepy 剪辑视频变成 gif 图
  5. android群英传不完整,Android群英传小总结
  6. 初出茅庐的小李第39篇博客之转载一篇有关unistd.h的介绍文章
  7. Python爬虫教你获取4K超清壁纸图片,手把手教你跟我一起爬!
  8. 忽悠马云10亿,还阿里4500亿:做对事赢一场,跟对人赢一生!(文章为转载,网上各种假原创,未搜到原作者)
  9. 启动nginx时报nginx.pid打开失败以及失效的解决方法
  10. web3再牛 也没能逃出这几个老巨头的手掌心