当前位置： 首页 > article >正文

YAPI--撰写接口文档的平台

article 2024/11/15 12:09:56

1 YAPI

1.1 YAPI介绍

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

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

其官网地址：http://yapi.smart-xwork.cn/

YApi主要提供了2个功能：

  • API接口管理：根据需求撰写接口，包括接口的地址，参数，响应等等信息。
  • Mock服务：模拟真实接口，生成接口的模拟测试数据，用于前端的测试。

1.2 接口文档管理

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

首先我们登录YAPI的官网，然后可以直接使用百度账号登录，没有的话去注册一个，如下图所示：

在这里插入图片描述

在这里插入图片描述

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

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Uc0evPIk-1683254031253)(assets/1669198453566.png)]
输入项目名称，点击创建
在这里插入图片描述

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

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-lfBu74Nl-1683254031253)(assets/1669198630531.png)]
添加用户管理分类
在这里插入图片描述

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

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-5zYR12Kz-1683254031253)(assets/1669289187162.png)]
添加完成后如下图所示
在这里插入图片描述
点击编辑
在这里插入图片描述

添加接口的请求参数，如下图所示：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-ulrCaTZC-1683254031255)(assets/1669289410729.png)]

添加接口的返回值，如下图所示：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-u4m9kpFb-1683254031255)(assets/1669289514661.png)]
添加备注信息，然后点击保存
在这里插入图片描述

然后保存上述设置，紧接着我们可以来到接口的预览界面，查询接口的信息，其效果如下图所示：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-7Y5pBY0k-1683254031256)(assets/1669289623957.png)]
在这里插入图片描述
点击Mock地址可以直接访问到json数据
在这里插入图片描述

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

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-hq0JS7Bv-1683254031257)(assets/1669289857670.png)]

来到接口的Mock设置窗口，如下图所示：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-IHMicKvu-1683254031257)(assets/1669290093854.png)]

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

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-UvREX5sV-1683254031258)(assets/1669290162900.png)]

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

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-qNZzlu8m-1683254031258)(assets/1669290210749.png)]

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


http://www.kler.cn/a/17919.html

相关文章：

  • IC 脚本之python
  • 「Mac玩转仓颉内测版12」PTA刷题篇3 - L1-003 个位数统计
  • 开源项目推荐——OpenDroneMap无人机影像数据处理
  • docker构建jdk11
  • 设计模式之装饰器模式(SSO单点登录功能扩展，增加拦截用户访问方法范围场景)
  • 844.比较含退格的字符串
  • ruby环境中的irb
  • 奇数单增序列
  • 有限等待忙等、让权等待死等、互斥遵循的几大原则——参考《天勤操作系统》，柳婼的博客
  • 基于C#开发 B/S架构的实验室管理系统 云LIS系统（MVC + SQLserver + Redis）
  • HTTP的特点
  • Python入门（三）变量和简单数据类型（二）
  • MySQL基础（十四）视图
  • 设计模式——模板方法模式
  • 数据结构与算法基础（王卓）（35）：交换排序之快排【第二阶段：标准答案、初步发现问题】
  • 看不懂具体的代码方法？这样向chatgpt提问
  • （22）目标检测算法之 yolov8模型导出总结
  • Scala Option类型,异常处理,IO,高阶函数
  • Ceph入门到精通-OSD 故障排除
  • TCP/IP相关面试题
  • 什么是数据库中的流程控制
  • gpt.4.0-gpt 国内版
  • 华为网工实验（VRRP多网关负载分担，OSPF基础操作）
  • Spring更简单的存取Bean
  • php 设置meta标签中的keywords | description | content-type | copyright的方法函数
  • 字符设备驱动