主机论坛

 找回密码
 立即注册
搜索
热搜: 活动 交友 discuz
查看: 141|回复: 8

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

[复制链接]

382

主题

2228

帖子

5952

积分

论坛元老

Rank: 8Rank: 8

积分
5952
发表于 2022-5-2 21:24:20 | 显示全部楼层 |阅读模式
本帖最后由 gdtv 于 2022-5-3 00:07 编辑

我做的一个返回用户数据的接口:
{
        "user_id":123,
        "user_name":"张三",
        "school":{
                "school_name":"广州第一中学",
                "school_type":"中学"
        },
        "user_address":{
                "province":"广东",
                "city":"广州"
        }
}


《用户接口文档》:
字段名
回复

使用道具 举报

121

主题

1129

帖子

2921

积分

金牌会员

Rank: 6Rank: 6

积分
2921
发表于 2022-5-2 21:51:30 | 显示全部楼层
你们没经理吗? 拉着前端找经理开会 让经理订
回复

使用道具 举报

11

主题

5744

帖子

1万

积分

论坛元老

Rank: 8Rank: 8

积分
11765
发表于 2022-5-2 21:49:39 | 显示全部楼层
这种情况是开发之间看的文档,就用markdown和swagger呗,一个可以双向引用一个支持json和在线测试。
回复

使用道具 举报

8

主题

236

帖子

860

积分

高级会员

Rank: 4

积分
860
发表于 2022-5-2 21:40:50 | 显示全部楼层
你跟前端至少要辞一个,不过我建议先把项目经理辞了。
回复

使用道具 举报

25

主题

1276

帖子

3209

积分

论坛元老

Rank: 8Rank: 8

积分
3209
发表于 2022-5-2 21:31:03 | 显示全部楼层
你们项目没项目经理吗? 有问题不问领导,在这问有毛用。。。
回复

使用道具 举报

0

主题

140

帖子

506

积分

高级会员

Rank: 4

积分
506
发表于 2022-5-2 21:34:35 | 显示全部楼层
看数据结构复不复杂喽 根据实际情况看要不要分文档
回复

使用道具 举报

91

主题

804

帖子

2193

积分

金牌会员

Rank: 6Rank: 6

积分
2193
发表于 2022-5-2 21:42:45 | 显示全部楼层
文档 双向引用 的作用
回复

使用道具 举报

7

主题

2012

帖子

4977

积分

论坛元老

Rank: 8Rank: 8

积分
4977
发表于 2022-5-2 21:49:27 | 显示全部楼层
你两打一架,打完就知道谁迁就谁了
回复

使用道具 举报

159

主题

1298

帖子

3241

积分

论坛元老

Rank: 8Rank: 8

积分
3241
发表于 2022-5-2 21:51:53 | 显示全部楼层
喵酱暗恋我 发表于 2022-5-2 21:51
你们没经理吗? 拉着前端找经理开会 让经理订

好方法



optimism
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

QQ|Archiver|手机版|小黑屋|主机论坛

GMT+8, 2024-4-23 18:21 , Processed in 0.075707 second(s), 18 queries .

Powered by Discuz! X3.4

Copyright © 2001-2020, Tencent Cloud.