作者cv123741 (cv123741)
看板Soft_Job
标题[请益] 有人的公司也没有提供API文件的吗
时间Sun Jan 1 19:11:08 2023
安安
小弟刚转前端，进到一家接案公司写网页，工作大概9成都在接API，
但公司内部没有提供api规格文件让我参考，
导致每次我都要通灵，
不然就是缠着後端不放，
「沟通」大概占了我1/3到1/2的开发时间，
公司虽然有说以後会要求有文件，但迟迟没下文...
有没有人也遇过同样问题的，这样要如何解决？
还是只能出下下策直接离职比较省事
----
Sent from
BePTT on my iPhone 11
--
※ 发信站: 批踢踢实业坊(ptt.cc), 来自: 112.78.88.96 (台湾)
※ 文章网址: https://webptt.com/cn.aspx?n=bbs/Soft_Job/M.1672571470.A.B35.html
1F：推 frank30941: 快逃啊01/01 19:28
2F：推 alihue: 问就是逃01/01 19:29
3F：推 samioplg: 连swagger都没有就是快逃01/01 19:34
4F：推 k798976869: 同上01/01 19:36
5F：→ rodion: 可以的话 就改用GraphQL吧01/01 19:58
6F：推 WaterLengend: 逃吧01/01 20:06
7F：推 loadingN: 离职是是上上策01/01 20:14
8F：推 w7236126: API文件很基本 没有还敢做？！01/01 20:18
9F：推 Belieeve: API没文件那至少订定API前端也要参与API的讨论01/01 21:07
10F：→ Belieeve: 不然QA有事都找前端，然後你一追又是API问题，还要负责01/01 21:08
11F：→ Belieeve: 说服後端改，会非常心累01/01 21:08
现在进行式 哭啊
12F：推 labbat: 开会纪录就是文件啊，要API规格去看信件串即可01/01 21:27
没开会纪录、公司信箱，有东西可以参考算我赚到
13F：→ labbat: 写文件很麻烦呀，而且写了不一定是对的01/01 21:27
14F：推 sakyle: 我这边相反耶，API文件写的图文并茂还是被巴着问01/01 21:28
15F：→ pig88003: 回楼上API写的很清楚但有时QA问做确认很正常吧…01/01 21:31
16F：→ KY1998: 没API文件叫後端全包01/01 21:42
17F：推 imhaha: 拿到api文件发现是参考用的才吐血吧01/01 21:47
18F：推 wei115: 有R 现在开发的东西就没API参考 也没注释 就一个API名称可01/01 21:52
19F：→ wei115: 以看 好一点的有原始码 可以边写边参考datasheet的暂存器01/01 21:53
20F：→ wei115: 来推测功能是什麽（顺便发现bug 照他这样写不会动） 坏一01/01 21:54
21F：→ wei115: 点的就全部包在*.a档里面 link进去的 就通灵幻想功能是什01/01 21:55
22F：→ wei115: 麽01/01 21:55
找到前辈了 可惜我连原始码都没
23F：→ wei115: 解决方法就是全文搜寻 看有没有其他程式用到这API 他是怎01/01 21:56
24F：→ wei115: 麽用的 还有最近发现 把残缺的扣丢给chatGPT 他通灵很厉害01/01 21:57
25F：→ agogoman: 没文件就算了, 我还遇过没原始码的, 只有一个孤单的dll01/01 22:08
26F：推 Merkle: API没文件你怎麽知道怎麽call?01/01 22:33
不能透露太多，怕被认出来，9成靠通灵
27F：→ kissmickey: 说真的一堆专案一手转一手 交接没完全真的要通灵 遇01/01 22:41
28F：→ kissmickey: 到这种如果是通例快走啊01/01 22:41
29F：→ kissmickey: 专案都不写文件的公司建议快闪01/01 22:43
30F：→ kissmickey: 一般开发文件设计规格 维护变更需求文件不是都很基本01/01 22:45
31F：推 s001582000: 我都是画面做功能 做出来主管再说哪边要改01/01 22:50
32F：推 s001582000: 原本以为这样管理很糟糕 但後来想想离职也都不用交接01/01 22:54
33F：→ s001582000: 其实颇爽01/01 22:54
34F：→ kissmickey: 是满爽的 只是後人会靠北 不然就是有屎都往前人泼01/01 22:56
35F：推 viper9709: 通灵王大战XD01/01 23:32
36F：→ somefatguy: 我最近接公司某个产品的API，虽然有文件但都英文01/02 00:06
37F：→ somefatguy: 重点不是英文，而是英文都错的看不懂在写三小01/02 00:06
38F：→ somefatguy: 还有公司code注解也一堆不知写三小的英文01/02 00:08
39F：→ somefatguy: 每次我都想干嘛不写中文01/02 00:08
40F：→ as30385438: 接案公司就不用期待了吧，功有练到就早点跳了01/02 00:17
41F：推 neo5277: swagger这麽好用.....01/02 00:47
42F：→ neo5277: 前端都这样给我们json後面就我们套出来给他这样01/02 00:47
43F：推 now99: 没文件栏位乱改不就惨了01/02 01:34
还没上线 所以还好
44F：推 holebro: 孤单dll xdd好克难01/02 02:01
45F：推 jinmin88: 直接跟主管讲 看他怎麽处理後端01/02 09:05
主管也知道 是公司没要求
46F：推 cplusplus426: 你面试有问 主管说有？ 结果没有？01/02 10:23
47F：推 maxjoiny: 请他们安装swagger01/02 10:46
48F：推 OriginStar: 写API文件要花时间，接案也要花时间。写API文件不会增01/02 11:42
49F：→ OriginStar: 加营收，接案可以增加营收。公司应该觉得花时间写API01/02 11:43
50F：→ OriginStar: 文件，不如多接案，反正员工免洗01/02 11:44
51F：推 BigCockman: 还好吧 更多接案公司都吗一人包前後端 直接不用浪费01/02 12:20
52F：→ BigCockman: 时间写文件 反正案子做得出来就好了01/02 12:20
53F：→ lairx: 问就是逃01/02 12:34
※ 编辑: cv123741 (112.78.88.96 台湾), 01/02/2023 12:51:15
54F：推 newbout: 接案公司尤其是小的的话感觉蛮正常的 01/02 13:25
55F：推 jobintan: 没文档就是大雷包。 01/02 14:49
56F：→ TakiDog: 陨石开发，只用Postman collocation + example 01/02 17:31
57F：→ TakiDog: 反而比swagger还方便些 01/02 17:32
58F：→ TakiDog: collocation(X collection(O 01/02 17:32
59F：推 henry6715: 很多小公司会这样，啥都没有，通灵大战xd 01/02 18:21
60F：→ firtaily: 有文件 文件还不一定对 01/02 18:30
61F：推 Killercat: API文件用gen的，不要用写的。用写的大家都不会更新他 01/02 22:54
62F：→ Killercat: 用gen的话 格式一改马上就能反映到文件上 01/02 22:54
63F：→ leolarrel: tdd领域的人会说测试就是文件 01/03 12:50
64F：→ knives: 逃 01/03 16:45
65F：→ dong531: 小公司小专案正常，而且有文件没有比较好，遇过有文件但 01/03 16:55
66F：→ dong531: 是万年没更新，跑去问结果叫你顺便更新文件 01/03 16:55
67F：推 xoy232: 待过小公司 真的都没有 逃或通灵 01/03 21:11
68F：推 JIKUAI: swagger或postman 至少要一个吧，不然就换家公司 01/04 00:29
69F：推 audy: 这样要怎麽接API阿，扯爆 01/04 12:29
70F：推 hn84908033: 有文件但不一定是对的 会更雷... 01/05 00:50
71F：推 crwu: 领导没有严格落实这个基础的文件有 是领导的责任 01/05 01:15
72F：推 CoNsTaR: Idris: 测试是啥？Type 就是文件 01/05 04:30
73F：推 bboy81905: model gen swagger, 轻轻松松 01/05 12:11
74F：→ bboy81905: 後端建置～初期习惯一下就好了 01/05 12:11
75F：推 ella123555: 你484我同事 01/05 16:30
76F：推 ccc1001: 就是公司思维了 除非主管换过一轮 建议快逃 01/05 16:53
77F：→ streakray: 跟你很像，但是至少有文件，只是每个文件参差不齐 01/07 01:56
78F：→ superpandal: 这没办法 这是人的问题 不管是文件和swagger还是 01/08 19:40
79F：→ superpandal: postman以及graphql都不能避免 文件写的差 api也可以 01/08 19:41
80F：→ superpandal: 写的差 api说明也可以写的差 01/08 19:41
81F：→ superpandal: 不过swagger类的工具要自己写也很简单 还可以自定义 01/08 19:45
82F：→ superpandal: 一些功能 01/08 19:45
83F：推 acgotaku: 没api文件是真的雷 不是家里没主管 就是主管也一起打混 01/09 20:32
84F：→ acgotaku: 这不是有没有纪律的问题 是根本不负责任的行为 01/09 20:33
85F：推 new122851: Swagger export to word 01/14 09:52