為什麼這篇api文件怎麼寫鄉民發文收入到精華區：因為在api文件怎麼寫這個討論話題中，有許多相關的文章在討論，這篇最有參考價值！作者cv123741 (cv123741)看板Soft_Job標題[請益] 有人的公司也沒有提供AP...
安安
小弟剛轉前端，進到一家接案公司寫網頁，工作大概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
推 frank30941: 快逃啊01/01 19:28
推 alihue: 問就是逃01/01 19:29
推 samioplg: 連swagger都沒有就是快逃01/01 19:34
推 k798976869: 同上01/01 19:36
→ rodion: 可以的話 就改用GraphQL吧01/01 19:58
推 WaterLengend: 逃吧01/01 20:06
推 loadingN: 離職是是上上策01/01 20:14
推 w7236126: API文件很基本 沒有還敢做？！01/01 20:18
推 Belieeve: API沒文件那至少訂定API前端也要參與API的討論01/01 21:07
→ Belieeve: 不然QA有事都找前端，然後你一追又是API問題，還要負責01/01 21:08
→ Belieeve: 說服後端改，會非常心累01/01 21:08
現在進行式 哭啊推 labbat: 開會紀錄就是文件啊，要API規格去看信件串即可01/01 21:27
沒開會紀錄、公司信箱，有東西可以參考算我賺到→ labbat: 寫文件很麻煩呀，而且寫了不一定是對的01/01 21:27
推 sakyle: 我這邊相反耶，API文件寫的圖文並茂還是被巴著問01/01 21:28
→ pig88003: 回樓上API寫的很清楚但有時QA問做確認很正常吧…01/01 21:31
→ KY1998: 沒API文件叫後端全包01/01 21:42
推 imhaha: 拿到api文件發現是參考用的才吐血吧01/01 21:47
推 wei115: 有R 現在開發的東西就沒API參考 也沒註釋 就一個API名稱可01/01 21:52
→ wei115: 以看 好一點的有原始碼 可以邊寫邊參考datasheet的暫存器01/01 21:53
→ wei115: 來推測功能是什麼（順便發現bug 照他這樣寫不會動） 壞一01/01 21:54
→ wei115: 點的就全部包在*.a檔裡面 link進去的 就通靈幻想功能是什01/01 21:55
→ wei115: 麼01/01 21:55
找到前輩了 可惜我連原始碼都沒→ wei115: 解決方法就是全文搜尋 看有沒有其他程式用到這API 他是怎01/01 21:56
→ wei115: 麼用的 還有最近發現 把殘缺的扣丟給chatGPT 他通靈很厲害01/01 21:57
→ agogoman: 沒文件就算了, 我還遇過沒原始碼的, 只有一個孤單的dll01/01 22:08
推 Merkle: API沒文件你怎麼知道怎麼call?01/01 22:33
不能透露太多，怕被認出來，9成靠通靈→ kissmickey: 說真的一堆專案一手轉一手 交接沒完全真的要通靈 遇01/01 22:41
→ kissmickey: 到這種如果是通例快走啊01/01 22:41
→ kissmickey: 專案都不寫文件的公司建議快閃01/01 22:43
→ kissmickey: 一般開發文件設計規格 維護變更需求文件不是都很基本01/01 22:45
推 s001582000: 我都是畫面做功能 做出來主管再說哪邊要改01/01 22:50
推 s001582000: 原本以為這樣管理很糟糕 但後來想想離職也都不用交接01/01 22:54
→ s001582000: 其實頗爽01/01 22:54
→ kissmickey: 是滿爽的 只是後人會靠北 不然就是有屎都往前人潑01/01 22:56
推 viper9709: 通靈王大戰XD01/01 23:32
→ somefatguy: 我最近接公司某個產品的API，雖然有文件但都英文01/02 00:06
→ somefatguy: 重點不是英文，而是英文都錯的看不懂在寫三小01/02 00:06
→ somefatguy: 還有公司code註解也一堆不知寫三小的英文01/02 00:08
→ somefatguy: 每次我都想幹嘛不寫中文01/02 00:08
→ as30385438: 接案公司就不用期待了吧，功有練到就早點跳了01/02 00:17
推 neo5277: swagger這麼好用.....01/02 00:47
→ neo5277: 前端都這樣給我們json後面就我們套出來給他這樣01/02 00:47
推 now99: 沒文件欄位亂改不就慘了01/02 01:34
還沒上線 所以還好推 holebro: 孤單dll xdd好克難01/02 02:01
推 jinmin88: 直接跟主管講 看他怎麼處理後端01/02 09:05
主管也知道 是公司沒要求推 cplusplus426: 你面試有問 主管說有？ 結果沒有？01/02 10:23
推 maxjoiny: 請他們安裝swagger01/02 10:46
推 OriginStar: 寫API文件要花時間，接案也要花時間。寫API文件不會增01/02 11:42
→ OriginStar: 加營收，接案可以增加營收。公司應該覺得花時間寫API01/02 11:43
→ OriginStar: 文件，不如多接案，反正員工免洗01/02 11:44
推 BigCockman: 還好吧 更多接案公司都嗎一人包前後端 直接不用浪費01/02 12:20
→ BigCockman: 時間寫文件 反正案子做得出來就好了01/02 12:20
→ lairx: 問就是逃01/02 12:34
※ 編輯: cv123741 (112.78.88.96 臺灣), 01/02/2023 12:51:15推 newbout: 接案公司尤其是小的的話感覺蠻正常的 01/02 13:25
推 jobintan: 沒文檔就是大雷包。 01/02 14:49
→ TakiDog: 隕石開發，只用Postman collocation + example 01/02 17:31
→ TakiDog: 反而比swagger還方便些 01/02 17:32
→ TakiDog: collocation(X collection(O 01/02 17:32
推 henry6715: 很多小公司會這樣，啥都沒有，通靈大戰xd 01/02 18:21
→ firtaily: 有文件 文件還不一定對 01/02 18:30
推 Killercat: API文件用gen的，不要用寫的。用寫的大家都不會更新他 01/02 22:54
→ Killercat: 用gen的話 格式一改馬上就能反映到文件上 01/02 22:54
→ leolarrel: tdd領域的人會說測試就是文件 01/03 12:50
→ knives: 逃 01/03 16:45
→ dong531: 小公司小專案正常，而且有文件沒有比較好，遇過有文件但 01/03 16:55
→ dong531: 是萬年沒更新，跑去問結果叫你順便更新文件 01/03 16:55
推 xoy232: 待過小公司 真的都沒有 逃或通靈 01/03 21:11
推 JIKUAI: swagger或postman 至少要一個吧，不然就換家公司 01/04 00:29
推 audy: 這樣要怎麼接API阿，扯爆 01/04 12:29
推 hn84908033: 有文件但不一定是對的 會更雷... 01/05 00:50
推 crwu: 領導沒有嚴格落實這個基礎的文件有 是領導的責任 01/05 01:15
推 CoNsTaR: Idris: 測試是啥？Type 就是文件 01/05 04:30
推 bboy81905: model gen swagger, 輕輕鬆鬆 01/05 12:11
→ bboy81905: 後端建置～初期習慣一下就好了 01/05 12:11
推 ella123555: 你484我同事 01/05 16:30
推 ccc1001: 就是公司思維了 除非主管換過一輪 建議快逃 01/05 16:53
→ streakray: 跟你很像，但是至少有文件，只是每個文件參差不齊 01/07 01:56
→ superpandal: 這沒辦法 這是人的問題 不管是文件和swagger還是 01/08 19:40
→ superpandal: postman以及graphql都不能避免 文件寫的差 api也可以 01/08 19:41
→ superpandal: 寫的差 api說明也可以寫的差 01/08 19:41
→ superpandal: 不過swagger類的工具要自己寫也很簡單 還可以自定義 01/08 19:45
→ superpandal: 一些功能 01/08 19:45
推 acgotaku: 沒api文件是真的雷 不是家裡沒主管 就是主管也一起打混 01/09 20:32
→ acgotaku: 這不是有沒有紀律的問題 是根本不負責任的行為 01/09 20:33
推 new122851: Swagger export to word 01/14 09:52