[請益] 有人的公司也沒有提供API文件的嗎

看板Soft_Job作者 (cv123741)時間1年前 (2023/01/01 19:11), 1年前編輯推噓38(38推 0噓 46→)
留言84則, 52人參與, 1年前最新討論串1/2 (看更多)
安安 小弟剛轉前端，進到一家接案公司寫網頁，工作大概9成都在接API， 但公司內部沒有提供api規格文件讓我參考， 導致每次我都要通靈， 不然就是纏著後端不放， 「溝通」大概佔了我1/3到1/2的開發時間， 公司雖然有說以後會要求有文件，但遲遲沒下文... 有沒有人也遇過同樣問題的，這樣要如何解決？ 還是只能出下下策直接離職比較省事 ---- Sent from BePTT on my iPhone 11 -- ※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 112.78.88.96 (臺灣) ※ 文章網址: https://www.ptt.cc/bbs/Soft_Job/M.1672571470.A.B35.html
推
01/01 19:28, 1年前 , 1F
快逃啊
01/01 19:28, 1F
推
01/01 19:29, 1年前 , 2F
問就是逃
01/01 19:29, 2F
推
01/01 19:34, 1年前 , 3F
連swagger都沒有就是快逃
01/01 19:34, 3F
推
01/01 19:36, 1年前 , 4F
同上
01/01 19:36, 4F
→
01/01 19:58, 1年前 , 5F
可以的話 就改用GraphQL吧
01/01 19:58, 5F
推
01/01 20:06, 1年前 , 6F
逃吧
01/01 20:06, 6F
推
01/01 20:14, 1年前 , 7F
離職是是上上策
01/01 20:14, 7F
推
01/01 20:18, 1年前 , 8F
API文件很基本 沒有還敢做？！
01/01 20:18, 8F
推
01/01 21:07, 1年前 , 9F
API沒文件那至少訂定API前端也要參與API的討論
01/01 21:07, 9F
→
01/01 21:08, 1年前 , 10F
不然QA有事都找前端，然後你一追又是API問題，還要負責
01/01 21:08, 10F
→
01/01 21:08, 1年前 , 11F
說服後端改，會非常心累
01/01 21:08, 11F
現在進行式 哭啊
推
01/01 21:27, 1年前 , 12F
開會紀錄就是文件啊，要API規格去看信件串即可
01/01 21:27, 12F
沒開會紀錄、公司信箱，有東西可以參考算我賺到
→
01/01 21:27, 1年前 , 13F
寫文件很麻煩呀，而且寫了不一定是對的
01/01 21:27, 13F
推
01/01 21:28, 1年前 , 14F
我這邊相反耶，API文件寫的圖文並茂還是被巴著問
01/01 21:28, 14F
→
01/01 21:31, 1年前 , 15F
回樓上API寫的很清楚但有時QA問做確認很正常吧…
01/01 21:31, 15F
→
01/01 21:42, 1年前 , 16F
沒API文件叫後端全包
01/01 21:42, 16F
推
01/01 21:47, 1年前 , 17F
拿到api文件發現是參考用的才吐血吧
01/01 21:47, 17F
推
01/01 21:52, 1年前 , 18F
有R 現在開發的東西就沒API參考 也沒註釋 就一個API名稱可
01/01 21:52, 18F
→
01/01 21:53, 1年前 , 19F
以看 好一點的有原始碼 可以邊寫邊參考datasheet的暫存器
01/01 21:53, 19F
→
01/01 21:54, 1年前 , 20F
來推測功能是什麼（順便發現bug 照他這樣寫不會動） 壞一
01/01 21:54, 20F
→
01/01 21:55, 1年前 , 21F
點的就全部包在*.a檔裡面 link進去的 就通靈幻想功能是什
01/01 21:55, 21F
→
01/01 21:55, 1年前 , 22F
麼
01/01 21:55, 22F
找到前輩了 可惜我連原始碼都沒
→
01/01 21:56, 1年前 , 23F
解決方法就是全文搜尋 看有沒有其他程式用到這API 他是怎
01/01 21:56, 23F
→
01/01 21:57, 1年前 , 24F
麼用的 還有最近發現 把殘缺的扣丟給chatGPT 他通靈很厲害
01/01 21:57, 24F
→
01/01 22:08, 1年前 , 25F
沒文件就算了, 我還遇過沒原始碼的, 只有一個孤單的dll
01/01 22:08, 25F
推
01/01 22:33, 1年前 , 26F
API沒文件你怎麼知道怎麼call?
01/01 22:33, 26F
不能透露太多，怕被認出來，9成靠通靈
→
01/01 22:41, 1年前 , 27F
說真的一堆專案一手轉一手 交接沒完全真的要通靈 遇
01/01 22:41, 27F
→
01/01 22:41, 1年前 , 28F
到這種如果是通例快走啊
01/01 22:41, 28F
→
01/01 22:43, 1年前 , 29F
專案都不寫文件的公司建議快閃
01/01 22:43, 29F
→
01/01 22:45, 1年前 , 30F
一般開發文件設計規格 維護變更需求文件不是都很基本
01/01 22:45, 30F
推
01/01 22:50, 1年前 , 31F
我都是畫面做功能 做出來主管再說哪邊要改
01/01 22:50, 31F
推
01/01 22:54, 1年前 , 32F
原本以為這樣管理很糟糕 但後來想想離職也都不用交接
01/01 22:54, 32F
→
01/01 22:54, 1年前 , 33F
其實頗爽
01/01 22:54, 33F
→
01/01 22:56, 1年前 , 34F
是滿爽的 只是後人會靠北 不然就是有屎都往前人潑
01/01 22:56, 34F
推
01/01 23:32, 1年前 , 35F
通靈王大戰XD
01/01 23:32, 35F
→
01/02 00:06, 1年前 , 36F
我最近接公司某個產品的API，雖然有文件但都英文
01/02 00:06, 36F
→
01/02 00:06, 1年前 , 37F
重點不是英文，而是英文都錯的看不懂在寫三小
01/02 00:06, 37F
→
01/02 00:08, 1年前 , 38F
還有公司code註解也一堆不知寫三小的英文
01/02 00:08, 38F
→
01/02 00:08, 1年前 , 39F
每次我都想幹嘛不寫中文
01/02 00:08, 39F
→
01/02 00:17, 1年前 , 40F
接案公司就不用期待了吧，功有練到就早點跳了
01/02 00:17, 40F
推
01/02 00:47, 1年前 , 41F
swagger這麼好用.....
01/02 00:47, 41F
→
01/02 00:47, 1年前 , 42F
前端都這樣給我們json後面就我們套出來給他這樣
01/02 00:47, 42F
推
01/02 01:34, 1年前 , 43F
沒文件欄位亂改不就慘了
01/02 01:34, 43F
還沒上線 所以還好
推
01/02 02:01, 1年前 , 44F
孤單dll xdd好克難
01/02 02:01, 44F
推
01/02 09:05, 1年前 , 45F
直接跟主管講 看他怎麼處理後端
01/02 09:05, 45F
主管也知道 是公司沒要求
推
01/02 10:23, 1年前 , 46F
你面試有問 主管說有？ 結果沒有？
01/02 10:23, 46F
推
01/02 10:46, 1年前 , 47F
請他們安裝swagger
01/02 10:46, 47F
推
01/02 11:42, 1年前 , 48F
寫API文件要花時間，接案也要花時間。寫API文件不會增
01/02 11:42, 48F
→
01/02 11:43, 1年前 , 49F
加營收，接案可以增加營收。公司應該覺得花時間寫API
01/02 11:43, 49F
→
01/02 11:44, 1年前 , 50F
文件，不如多接案，反正員工免洗
01/02 11:44, 50F
推
01/02 12:20, 1年前 , 51F
還好吧 更多接案公司都嗎一人包前後端 直接不用浪費
01/02 12:20, 51F
→
01/02 12:20, 1年前 , 52F
時間寫文件 反正案子做得出來就好了
01/02 12:20, 52F
→
01/02 12:34, 1年前 , 53F
問就是逃
01/02 12:34, 53F
※ 編輯: cv123741 (112.78.88.96 臺灣), 01/02/2023 12:51:15
推
01/02 13:25, 1年前 , 54F
接案公司尤其是小的的話感覺蠻正常的
01/02 13:25, 54F
推
01/02 14:49, 1年前 , 55F
沒文檔就是大雷包。
01/02 14:49, 55F
→
01/02 17:31, 1年前 , 56F
隕石開發，只用Postman collocation + example
01/02 17:31, 56F
→
01/02 17:32, 1年前 , 57F
反而比swagger還方便些
01/02 17:32, 57F
→
01/02 17:32, 1年前 , 58F
collocation(X collection(O
01/02 17:32, 58F
推
01/02 18:21, 1年前 , 59F
很多小公司會這樣，啥都沒有，通靈大戰xd
01/02 18:21, 59F
→
01/02 18:30, 1年前 , 60F
有文件 文件還不一定對
01/02 18:30, 60F
推
01/02 22:54, 1年前 , 61F
API文件用gen的，不要用寫的。用寫的大家都不會更新他
01/02 22:54, 61F
→
01/02 22:54, 1年前 , 62F
用gen的話 格式一改馬上就能反映到文件上
01/02 22:54, 62F
→
01/03 12:50, 1年前 , 63F
tdd領域的人會說測試就是文件
01/03 12:50, 63F
→
01/03 16:45, 1年前 , 64F
逃
01/03 16:45, 64F
→
01/03 16:55, 1年前 , 65F
小公司小專案正常，而且有文件沒有比較好，遇過有文件但
01/03 16:55, 65F
→
01/03 16:55, 1年前 , 66F
是萬年沒更新，跑去問結果叫你順便更新文件
01/03 16:55, 66F
推
01/03 21:11, 1年前 , 67F
待過小公司 真的都沒有 逃或通靈
01/03 21:11, 67F
推
01/04 00:29, 1年前 , 68F
swagger或postman 至少要一個吧，不然就換家公司
01/04 00:29, 68F
推
01/04 12:29, 1年前 , 69F
這樣要怎麼接API阿，扯爆
01/04 12:29, 69F
推
01/05 00:50, 1年前 , 70F
有文件但不一定是對的 會更雷...
01/05 00:50, 70F
推
01/05 01:15, 1年前 , 71F
領導沒有嚴格落實這個基礎的文件有 是領導的責任
01/05 01:15, 71F
推
01/05 04:30, 1年前 , 72F
Idris: 測試是啥？Type 就是文件
01/05 04:30, 72F
推
01/05 12:11, 1年前 , 73F
model gen swagger, 輕輕鬆鬆
01/05 12:11, 73F
→
01/05 12:11, 1年前 , 74F
後端建置～初期習慣一下就好了
01/05 12:11, 74F
推
01/05 16:30, 1年前 , 75F
你484我同事
01/05 16:30, 75F
推
01/05 16:53, 1年前 , 76F
就是公司思維了 除非主管換過一輪 建議快逃
01/05 16:53, 76F
→
01/07 01:56, 1年前 , 77F
跟你很像，但是至少有文件，只是每個文件參差不齊
01/07 01:56, 77F
→
01/08 19:40, 1年前 , 78F
這沒辦法 這是人的問題 不管是文件和swagger還是
01/08 19:40, 78F
→
01/08 19:41, 1年前 , 79F
postman以及graphql都不能避免 文件寫的差 api也可以
01/08 19:41, 79F
→
01/08 19:41, 1年前 , 80F
寫的差 api說明也可以寫的差
01/08 19:41, 80F
→
01/08 19:45, 1年前 , 81F
不過swagger類的工具要自己寫也很簡單 還可以自定義
01/08 19:45, 81F
→
01/08 19:45, 1年前 , 82F
一些功能
01/08 19:45, 82F
推
01/09 20:32, 1年前 , 83F
沒api文件是真的雷 不是家裡沒主管 就是主管也一起打混
01/09 20:32, 83F
→
01/09 20:33, 1年前 , 84F
這不是有沒有紀律的問題 是根本不負責任的行為
01/09 20:33, 84F
‣ 更多 cv123741 的文章
文章代碼(AID): #1ZiMfEir (Soft_Job)
‣ 更多 cv123741 的文章
文章代碼(AID): #1ZiMfEir (Soft_Job)