ARTICLE DETAIL

资讯详情

深耕网站建设、视觉设计与SEO优化的一线实战洞察。

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

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

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

查看接口信息

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

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

返回值类型

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

还可以填写备注信息

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

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

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

/users是资源的名称

在做用户相关的

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

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

接口设计允许后续修改

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

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

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

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

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

整理之后

返回列表