看吧澎湃

  • hostloc
  • Google
  • 建站教程
    • SEO优化
    • wp教程
看吧澎湃
,hostloc主机,gooogle教程,建站技术教程,SEO建站优化
  1. 首页
  2. hostloc
  3. 正文

前端工程师这个要求是否合理之二 :文档的问题

2022年5月3日 15点热度 0人点赞 0条评论

我做的一个返回用户数据的接口:

{
"user_id":123,
"user_name":"张三",
"school":{
"school_name":"广州第一中学",
"school_type":"中学"
},
"user_address":{
"province":"广东",
"city":"广州"
}
}

《用户接口文档》:

字段名 说明 user_id 用户iduser_name 姓名school学校数据结构user_address地址数据结构

因为多个接口都用到school和user_address,所以我把他们写到一个单独的《接口通用数据说明文档》:

school学校数据结构:
字段名 说明 school_name 学校名称school_type 学校类型
user_address地址数据结构:
字段名 说明 province 省份city城市

前端工程师的吐槽:

我打开《用户接口文档》看,然后还要再打开《接口通用数据说明文档》去找对应的字段,太麻烦了,你能不能把"学校数据结构"和"地址数据结构"都写到《用户接口文档》里?

请教一下,你们是怎么写文档的呢?
-------------------------------------
前端工程师这个要求是否合理之一: https://hostloc.com/forum.php?mod=viewthread&tid=1010810

上一篇:求助:有没有大佬帮忙分析我的V2为啥连不上了?
下一篇:利用cloudflare的邮件路由来建立自己的安全邮件服务器

你们没经理吗? 拉着前端找经理开会 让经理订这种情况是开发之间看的文档,就用markdown和swagger呗,一个可以双向引用一个支持json和在线测试。你跟前端至少要辞一个,不过我建议先把项目经理辞了。你们项目没项目经理吗? 有问题不问领导,在这问有毛用。。。看数据结构复不复杂喽 根据实际情况看要不要分文档文档 双向引用 的作用你两打一架,打完就知道谁迁就谁了

喵酱暗恋我 发表于 2022-5-2 21:51
你们没经理吗? 拉着前端找经理开会 让经理订

好方法
optimism

标签: name school user
最后更新:2022年5月3日

hange

这个人很懒,什么都没留下

点赞
< 上一篇
下一篇 >

文章评论

取消回复
标签聚合
g 收个 e 注册 下载 已出 邮箱 域名 小鸡 腾讯 续费 账号 qq vir amp 迁移 t 大佬 com aff wordpress 流量 https vps google cf tg mjj ip 微信
最新 热点 随机
最新 热点 随机
我去加拿大也不去美国 搭建好的网盘域名+程序有人要么? 王卡配wifi岂不是绝杀? 有自动循环按键软件吗 有没有啥推荐发验证码短信平台 卖米咯 全在谷歌
Layui下拉选框使用change无效 如何取值赋值渲染求助∶怎么屏蔽loc帖子mjj的头像宝塔只备份是网站还能恢复吗求推荐小说,上本看完的是回到明朝当暴君折价短租一台dmit.LAX.Pro在收个asu
太简单了captcha 我想搞抖音,不知道从哪里入手。 5刀内有什么科学鸡可选? 网站不加index.aspx首页就500是什么情况 收个2字母.nl域名 决定卖房不断供了

COPYRIGHT © 2022 kbpp.org. ALL RIGHTS RESERVED.

Theme Kratos Made By Seaton Jiang