PTT推薦

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

看板Soft_Job標題Re: [請益] 有人的公司也沒有提供API文件的嗎作者
lovdkkkk
(dk)
時間推噓 3 推:3 噓:0 →:1

※ 引述《cv123741 (cv123741)》之銘言:
: 標題: [請益] 有人的公司也沒有提供API文件的嗎
: 時間: Sun Jan 1 19:11:08 2023
:
: 安安
:
: 小弟剛轉前端,進到一家接案公司寫網頁,工作大概9成都在接API,
: 但公司內部沒有提供api規格文件讓我參考,
: 導致每次我都要通靈,
: 不然就是纏著後端不放,
:
: 「溝通」大概佔了我1/3到1/2的開發時間,
:
: 公司雖然有說以後會要求有文件,但遲遲沒下文...
:
:
: 有沒有人也遇過同樣問題的,這樣要如何解決?
:
: 還是只能出下下策直接離職比較省事

幾種可能做法

1. 寫在 issue comments

假如有用 github 開 issue 給後端做 API,
請後端完成後將他測試時的 code 貼上去
這對新 API 應該沒什麼問題,舊有的就不一定

2. 記在 Postman

開一個 Postman 帳號,下次去找後端當面邊問邊記錄到 Postman,
然後問後端未來遇到不懂的 API 能不能直接請他補進 Postman,
通常應該是會願意,自己補應該比問答後再補省事

Swagger 看開發環境支援什麼做法,如果只能用註解寫文件就不太好做,
如果能直接側錄或融入開發 config 的話就比較好

3. 推 api 測試

類似 1 也是請後端寫測試 code,但這可擴及舊有 API,
但前期投入會比較多不一定推得成,
如果有辦法就自己開個頭把前置環境都弄好,
再像補 Postman 一樣需要時請後端補



--

※ PTT留言評論
※ 發信站: 批踢踢實業坊(ptt.cc), 來自: 111.241.213.212 (臺灣)
PTT 網址

MoonCode01/03 18:08幫 QQ

scorpion01/04 01:24卑微的前端。

lovetzuyu2301/04 23:04大部分9成的公司都沒有啦,前端的我是自己找到一套a

lovetzuyu2301/04 23:04pi文檔管理套件做管理