※ 本文轉寄自 ptt.cc, 文章原始頁面
看板Soft_Job
標題

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

時間
最新2024-01-14 09:52:00
留言85則留言,53人參與討論
推噓39 ( 39046 )
安安 小弟剛轉前端,進到一家接案公司寫網頁,工作大概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

Re: 回文串

3985
> [請益] 有人的公司也沒有提供API文件的嗎
Soft_Job01/01 19:11

85 則留言

frank30941, 1F
快逃啊

alihue, 2F
問就是逃

samioplg, 3F
連swagger都沒有就是快逃

k798976869, 4F
同上

rodion, 5F
可以的話 就改用GraphQL吧

WaterLengend, 6F
逃吧

loadingN, 7F
離職是是上上策

w7236126, 8F
API文件很基本 沒有還敢做?!

Belieeve, 9F
API沒文件那至少訂定API前端也要參與API的討論

Belieeve, 10F
不然QA有事都找前端,然後你一追又是API問題,還要負責

Belieeve, 11F
說服後端改,會非常心累
現在進行式 哭啊

labbat, 12F
開會紀錄就是文件啊,要API規格去看信件串即可
沒開會紀錄、公司信箱,有東西可以參考算我賺到

labbat, 13F
寫文件很麻煩呀,而且寫了不一定是對的

sakyle, 14F
我這邊相反耶,API文件寫的圖文並茂還是被巴著問

pig88003, 15F
回樓上API寫的很清楚但有時QA問做確認很正常吧…

KY1998, 16F
沒API文件叫後端全包

imhaha, 17F
拿到api文件發現是參考用的才吐血吧

wei115, 18F
有R 現在開發的東西就沒API參考 也沒註釋 就一個API名稱可

wei115, 19F
以看 好一點的有原始碼 可以邊寫邊參考datasheet的暫存器

wei115, 20F
來推測功能是什麼(順便發現bug 照他這樣寫不會動) 壞一

wei115, 21F
點的就全部包在*.a檔裡面 link進去的 就通靈幻想功能是什

wei115, 22F
找到前輩了 可惜我連原始碼都沒

wei115, 23F
解決方法就是全文搜尋 看有沒有其他程式用到這API 他是怎

wei115, 24F
麼用的 還有最近發現 把殘缺的扣丟給chatGPT 他通靈很厲害

agogoman, 25F
沒文件就算了, 我還遇過沒原始碼的, 只有一個孤單的dll

Merkle, 26F
API沒文件你怎麼知道怎麼call?
不能透露太多,怕被認出來,9成靠通靈

kissmickey, 27F
說真的一堆專案一手轉一手 交接沒完全真的要通靈 遇

kissmickey, 28F
到這種如果是通例快走啊

kissmickey, 29F
專案都不寫文件的公司建議快閃

kissmickey, 30F
一般開發文件設計規格 維護變更需求文件不是都很基本

s001582000, 31F
我都是畫面做功能 做出來主管再說哪邊要改

s001582000, 32F
原本以為這樣管理很糟糕 但後來想想離職也都不用交接

s001582000, 33F
其實頗爽

kissmickey, 34F
是滿爽的 只是後人會靠北 不然就是有屎都往前人潑

viper9709, 35F
通靈王大戰XD

somefatguy, 36F
我最近接公司某個產品的API,雖然有文件但都英文

somefatguy, 37F
重點不是英文,而是英文都錯的看不懂在寫三小

somefatguy, 38F
還有公司code註解也一堆不知寫三小的英文

somefatguy, 39F
每次我都想幹嘛不寫中文

ccc1001, 79F
就是公司思維了 除非主管換過一輪 建議快逃

streakray, 80F
跟你很像,但是至少有文件,只是每個文件參差不齊

superpandal, 81F
這沒辦法 這是人的問題 不管是文件和swagger還是

superpandal, 82F
postman以及graphql都不能避免 文件寫的差 api也可以

superpandal, 83F
寫的差 api說明也可以寫的差

superpandal, 84F
不過swagger類的工具要自己寫也很簡單 還可以自定義

superpandal, 85F
一些功能

acgotaku, 86F
沒api文件是真的雷 不是家裡沒主管 就是主管也一起打混

acgotaku, 87F
這不是有沒有紀律的問題 是根本不負責任的行為

new122851, 88F
Swagger export to word