当前位置: 首页 > news >正文

企业做接口设计时常用的工具---YAPI,以及如何去分析一个接口的请求方式、请求路径、请求参数、返回值(明面的看产品原型图,隐含的需要自己分析)

在公司内部往往需要搭建一个内部YAPI的私服

查看接口信息

编辑接口信息,新增接口也会进入到这个界面

一个关键是接口路径,另一个关键是接口的请求方式

返回值类型

data是一个数组,里面装的是item是object类型的,包含了每个item的示例值和说明

还可以填写备注信息

Mock地址会按照定义好的规范返回结果

接口路径一般按照RestFul风格开发

/us是微服务的名字,然后再带上具体的路径

/users是资源的名称

在做用户相关的

一般情况下增删改不会有返回值,而查询会有详细的返回值

返回值要看页面原型图,看页面渲染的时候需要什么字段,就给什么字段,以及分析隐含的字段,结合页面原型图去分析

接口设计允许后续修改

分页查询,必须要告诉前端总共的条数和当前的页数,这样才可以生成一个分页条

当前页面展示的数据要根据页面原型图去完成,页面需要什么,就要返回什么

当前课表相关的功能在学习中心的微服务实现的

而课程是在课程微服务里面实现的

在页面上搜索直接看到的是课程,课表里面关联了课程

整理之后

http://www.rkmt.cn/news/155397.html

相关文章:

  • Dify如何维持长篇叙事的一致性?
  • Dify平台的财务预测建模能力初探
  • L298N控制直流电机的超详细版入门教程
  • 时序逻辑电路状态机设计:完整指南与实例解析
  • 终极游戏模组管理指南:一站式解决方案
  • 5分钟掌握Boss直聘自动化投简历:彻底告别手动求职时代
  • DS4Windows完整配置手册:在PC上实现PS手柄完美兼容的解决方案
  • XML编辑器终极指南:从新手到专家的完整教程
  • Agentic-GraphRAG 架构实践:较 GraphRAG 成本降低90%
  • hi3516只有这3中音频编码,添加了4字节帧头
  • 5、Java 银行交易分析:聚合、导出与异常处理
  • Relight:AI光影魔术师!一键重塑照片光线质感
  • 手把手教程:Multisim14.3下载安装用于高校实验课程准备
  • Xenos Windows DLL注入器:5分钟快速上手指南
  • 新手必看:理解工业串行通信中的奇偶校验
  • 智能内容访问助手:2024年终极使用指南
  • 【Python办公自动化】Excel转Json-自定义键值对-可映射键名(2026极速版)
  • 音乐解锁工具终极指南:完全免费解决加密音乐播放难题
  • 网盘直链解析工具完整指南:突破下载限制的20+平台解决方案
  • Anthropic开源Skills项目,打响了智能体标准化的第一枪
  • 音乐解锁终极指南:如何免费解锁所有加密音乐文件
  • 深度解析 SeaTunnel 断点续传机制:架构、实现与最佳实践
  • 嵌入控件到QListView:委托与模型协同示例
  • CAPL编程新手教程:CANoe中变量与函数定义
  • Dify平台的魔法体系自洽性分析
  • Dify平台的参考文献自动生成质量评估
  • 【SmoothMixWan22文生视频工作流分享】比原工作流进行了加速改进: Wan 2.2 +加速 +插帧 +放大高清
  • 11、Puppet开发、部署与扩展:最佳实践指南
  • 终极字符渲染优化方案:彻底解决游戏中文乱码显示问题
  • 一文说清时序逻辑电路时序图的读取方法