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

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

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

查看接口信息

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

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

返回值类型

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

还可以填写备注信息

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

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

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

/users是资源的名称

在做用户相关的

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

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

接口设计允许后续修改

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

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

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

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

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

整理之后

http://www.jsqmd.com/news/141240/

相关文章:

  • Dify在粤语口语表达生成中的地道程度评测
  • Dify如何维持长篇叙事的一致性?
  • 终极免费AI字幕翻译工具:PotPlayer百度翻译插件完整配置指南
  • Dify平台的财务预测建模能力初探
  • L298N控制直流电机的超详细版入门教程
  • Dify如何生成合理的估值区间建议?
  • 时序逻辑电路状态机设计:完整指南与实例解析
  • Dify平台的迭代回顾总结自动生成质量评估
  • Dify如何打造病毒式传播文案?
  • 专项智能练习(中国古代文学)
  • IDEA插件版摸鱼看书神器:3种方式在开发环境中高效阅读
  • 终极指南:如何在IDEA中打造私密阅读空间,提升程序员工作幸福感
  • 终极游戏模组管理指南:一站式解决方案
  • 11、规则建模、构建与应用及Twootr系统开发全解析
  • Dify在节日祝福语个性化生成中的温馨体验
  • 手把手Elasticsearch教程:搭建企业级日志平台
  • 5分钟掌握Boss直聘自动化投简历:彻底告别手动求职时代
  • DS4Windows完整配置手册:在PC上实现PS手柄完美兼容的解决方案
  • NCM文件转换工具:轻松解锁网易云音乐加密格式
  • XML编辑器终极指南:从新手到专家的完整教程
  • Agentic-GraphRAG 架构实践:较 GraphRAG 成本降低90%
  • GetQzonehistory终极指南:如何一键备份QQ空间所有历史数据
  • 12、软件架构设计与开发实践:从解耦到安全实现
  • DeepSeek-V3.1重磅升级:双模式AI效率与智能新突破
  • 基于PWM控制的有源蜂鸣器节能发声模式探讨
  • 4、银行交易分析器的测试、扩展与设计原则
  • Visual C++运行库智能管理:告别版本冲突与安装失败的终极方案
  • Dify如何生成吸引点击的公众号推文标题?
  • hi3516只有这3中音频编码,添加了4字节帧头
  • Relight:AI光影魔术师!一键重塑照片光线质感