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

作者: cv123741 (cv123741)   2023-01-01 19:11:08
安安
小弟剛轉前端,進到一家接案公司寫網頁,工作大概9成都在接API,
但公司內部沒有提供api規格文件讓我參考,
導致每次我都要通靈,
不然就是纏著後端不放,
「溝通」大概佔了我1/3到1/2的開發時間,
公司雖然有說以後會要求有文件,但遲遲沒下文...
有沒有人也遇過同樣問題的,這樣要如何解決?
還是只能出下下策直接離職比較省事
作者: frank30941 (frank30941)   2023-01-01 19:28:00
快逃啊
作者: alihue (wanda wanda)   2023-01-01 19:29:00
問就是逃
作者: samioplg (war3)   2023-01-01 19:34:00
連swagger都沒有就是快逃
作者: k798976869 (kk)   2023-01-01 19:36:00
同上
作者: rodion (r-kan/reminder)   2023-01-01 19:58:00
可以的話 就改用GraphQL吧
作者: WaterLengend (Leeeeeeeeooooooo)   2023-01-01 20:06:00
逃吧
作者: loadingN (sarsaparilla)   2023-01-01 20:14:00
離職是是上上策
作者: w7236126   2023-01-01 20:18:00
API文件很基本 沒有還敢做?!
作者: Belieeve (芥末拿鐵)   2023-01-01 21:07:00
API沒文件那至少訂定API前端也要參與API的討論不然QA有事都找前端,然後你一追又是API問題,還要負責說服後端改,會非常心累
作者: labbat (labbat)   2023-01-01 21:27:00
開會紀錄就是文件啊,要API規格去看信件串即可寫文件很麻煩呀,而且寫了不一定是對的
作者: sakyle (Sakyle)   2023-01-01 21:28:00
我這邊相反耶,API文件寫的圖文並茂還是被巴著問
作者: pig88003 (Bar鈞)   2023-01-01 21:31:00
回樓上API寫的很清楚但有時QA問做確認很正常吧…
作者: KY1998 (HAN)   2023-01-01 21:42:00
沒API文件叫後端全包
作者: imhaha (嘿嘿)   2023-01-01 21:47:00
拿到api文件發現是參考用的才吐血吧
作者: wei115 (ㄎㄎ)   2023-01-01 21:52:00
有R 現在開發的東西就沒API參考 也沒註釋 就一個API名稱可以看 好一點的有原始碼 可以邊寫邊參考datasheet的暫存器來推測功能是什麼(順便發現bug 照他這樣寫不會動) 壞一點的就全部包在*.a檔裡面 link進去的 就通靈幻想功能是什麼解決方法就是全文搜尋 看有沒有其他程式用到這API 他是怎麼用的 還有最近發現 把殘缺的扣丟給chatGPT 他通靈很厲害
作者: agogoman (cocorosie)   2023-01-01 22:08:00
沒文件就算了, 我還遇過沒原始碼的, 只有一個孤單的dll
作者: Merkle (你在想奇怪的東西齁)   2023-01-01 22:33:00
API沒文件你怎麼知道怎麼call?
作者: kissmickey (無言)   2023-01-01 22:41:00
說真的一堆專案一手轉一手 交接沒完全真的要通靈 遇到這種如果是通例快走啊專案都不寫文件的公司建議快閃一般開發文件設計規格 維護變更需求文件不是都很基本
作者: s001582000 (仁傑)   2023-01-01 22:50:00
我都是畫面做功能 做出來主管再說哪邊要改原本以為這樣管理很糟糕 但後來想想離職也都不用交接其實頗爽
作者: kissmickey (無言)   2023-01-01 22:56:00
是滿爽的 只是後人會靠北 不然就是有屎都往前人潑
作者: viper9709 (阿達)   2023-01-01 23:32:00
通靈王大戰XD
作者: somefatguy   2023-01-02 00:06:00
我最近接公司某個產品的API,雖然有文件但都英文重點不是英文,而是英文都錯的看不懂在寫三小還有公司code註解也一堆不知寫三小的英文每次我都想幹嘛不寫中文
作者: as30385438 (LCT)   2023-01-02 00:17:00
接案公司就不用期待了吧,功有練到就早點跳了
作者: neo5277 (I am an agent of chaos)   2023-01-02 00:47:00
swagger這麼好用.....前端都這樣給我們json後面就我們套出來給他這樣
作者: now99 (陳在天)   2023-01-02 01:34:00
沒文件欄位亂改不就慘了
作者: holebro (穴弟弟)   2023-01-02 02:01:00
孤單dll xdd好克難
作者: jinmin88 (晝伏夜出)   2023-01-02 09:05:00
直接跟主管講 看他怎麼處理後端
作者: cplusplus426 (c++)   2023-01-02 10:23:00
你面試有問 主管說有? 結果沒有?
作者: maxjoiny (封塵)   2023-01-02 10:46:00
請他們安裝swagger
作者: OriginStar   2023-01-02 11:42:00
寫API文件要花時間,接案也要花時間。寫API文件不會增加營收,接案可以增加營收。公司應該覺得花時間寫API文件,不如多接案,反正員工免洗
作者: BigCockman (大雕男)   2023-01-02 12:20:00
還好吧 更多接案公司都嗎一人包前後端 直接不用浪費時間寫文件 反正案子做得出來就好了
作者: lairx (lairx)   2023-01-02 12:34:00
問就是逃
作者: newbout ( nb 但沒有 a )   2023-01-02 13:25:00
接案公司尤其是小的的話感覺蠻正常的
作者: jobintan (Robin Artemstein)   2023-01-02 14:49:00
沒文檔就是大雷包。
作者: TakiDog (多奇狗)   2023-01-02 17:31:00
隕石開發,只用Postman collocation + example反而比swagger還方便些collocation(X collection(O
作者: henry6715 (阿摩哥)   2023-01-02 18:21:00
很多小公司會這樣,啥都沒有,通靈大戰xd
作者: firtaily (firtaily)   2023-01-02 18:30:00
有文件 文件還不一定對
作者: Killercat (殺人貓™)   2023-01-02 22:54:00
API文件用gen的,不要用寫的。用寫的大家都不會更新他用gen的話 格式一改馬上就能反映到文件上
作者: leolarrel (真.粽子無雙)   2023-01-03 12:50:00
tdd領域的人會說測試就是文件
作者: knives   2023-01-03 16:45:00
作者: dong531 (貓王)   2023-01-03 16:55:00
小公司小專案正常,而且有文件沒有比較好,遇過有文件但是萬年沒更新,跑去問結果叫你順便更新文件
作者: xoy232 (鬼島希特勒)   2023-01-03 21:11:00
待過小公司 真的都沒有 逃或通靈
作者: JIKUAI (聽媽媽說)   2023-01-04 00:29:00
swagger或postman 至少要一個吧,不然就換家公司
作者: audy (audy)   2023-01-04 12:29:00
這樣要怎麼接API阿,扯爆
作者: hn84908033 (PAMIS)   2023-01-05 00:50:00
有文件但不一定是對的 會更雷...
作者: crwu   2023-01-05 01:15:00
領導沒有嚴格落實這個基礎的文件有 是領導的責任
作者: CoNsTaR ((const *))   2023-01-05 04:30:00
Idris: 測試是啥?Type 就是文件
作者: bboy81905 (莊家)   2023-01-05 12:11:00
model gen swagger, 輕輕鬆鬆後端建置~初期習慣一下就好了
作者: ella123555 (LynnHuang)   2023-01-05 16:30:00
你484我同事
作者: ccc1001 (你不是吧)   2023-01-05 16:53:00
就是公司思維了 除非主管換過一輪 建議快逃
作者: streakray (條紋衣boy)   2023-01-07 01:56:00
跟你很像,但是至少有文件,只是每個文件參差不齊
作者: superpandal   2023-01-08 19:40:00
這沒辦法 這是人的問題 不管是文件和swagger還是postman以及graphql都不能避免 文件寫的差 api也可以寫的差 api說明也可以寫的差不過swagger類的工具要自己寫也很簡單 還可以自定義一些功能
作者: acgotaku (otaku)   2023-01-09 20:32:00
沒api文件是真的雷 不是家裡沒主管 就是主管也一起打混這不是有沒有紀律的問題 是根本不負責任的行為
作者: new122851 (未若柳絮因風起)   2023-01-14 09:52:00
Swagger export to word

Links booklink

Contact Us: admin [ a t ] ucptt.com