iT邦幫忙

0

寫開發文件

  • 分享至 

  • xImage

想問一下,後端工程師在開發時,寫文件紀錄API怎麼串接跟request, response分別是哪些資料這件事是理所當然,還是說有寫是因為後端人好,要感謝他?

powerc iT邦研究生 5 級 ‧ 2023-04-26 11:32:49 檢舉
正常來說一個完整的團隊應該會包含SA跟PG,通常會由SA寫這些文件。
但我也有遇過案子沒有SA,就由PG自行撰寫自己負責的模組功能的文件,如下面大大所說,只有你才懂你開發的API,所以由你寫出來是非常正常的。
Yaowen iT邦研究生 3 級 ‧ 2023-04-26 15:08:41 檢舉
請他至少有用swagger吧
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中
0
難神
iT邦新手 5 級 ‧ 2023-04-25 18:15:41

以我的經歷來說(經過三個案子),結案前通常都要完成規格書,裡面就會包含你說的那些,每一項都要寫得清楚並加上備註,現在第四個案子了覺得是後端人員該做的,因為只有自己最懂自己寫的用途與使用方法~
/images/emoticon/emoticon13.gif

janlin002 iT邦好手 1 級 ‧ 2023-04-26 09:18:29 檢舉

結案前?不是開發中就要寫了嗎?

難神 iT邦新手 5 級 ‧ 2023-04-26 17:00:05 檢舉

每個團隊、公司都有不同做法,我遇到的都是結案前填寫唷

janlin002 iT邦好手 1 級 ‧ 2023-04-26 17:11:29 檢舉

了解,感謝你的分享

【**此則訊息已被站方移除**】
0
whitefloor
iT邦研究生 2 級 ‧ 2023-04-25 22:19:20

感謝後端是誰講的= =
你寫API沒寫規格
鬼才知道要怎麼call server

看更多先前的回應...收起先前的回應...
janlin002 iT邦好手 1 級 ‧ 2023-04-26 09:15:57 檢舉

有遇過團隊是只告訴你 api需要的 request 資料,但回傳的 response 跟裡面代表意思都沒給

whitefloor iT邦研究生 2 級 ‧ 2023-04-26 10:59:55 檢舉

那只能勸你快逃了,工程師也是有程度之分的。

wuewen iT邦新手 5 級 ‧ 2023-04-26 11:03:27 檢舉

所以是要靠擲筊知道response的含意嗎?還是說理解錯誤要怪自己理解能力差。

wuewen iT邦新手 5 級 ‧ 2023-04-26 11:28:04 檢舉

還有和遇到的"人(垃圾)"有關係,公司同事遇過(對方是API端)開發前已討論好A介接格式,開發好測試時才知變成B介接格式,開發好測試完成上正式機時變成C介接格式,只因為A=>B沒有通知我們,我們向甲方反應而已,所以"人"很重要。

janlin002 iT邦好手 1 級 ‧ 2023-04-26 13:52:09 檢舉

可能要通靈才能知道response含義,但如果真的不清楚的話,還是可以問後端的

janlin002 iT邦好手 1 級 ‧ 2023-04-26 13:55:15 檢舉

wuewen目前經驗來看,API需求變來變去好像挺正常的?你這邊講述的例子,我還真遇過,然後事後就會跟你說,你們前端改一下應該不會很久吧...

wuewen iT邦新手 5 級 ‧ 2023-04-26 14:34:56 檢舉

janlin002我們這件事,是在開發中對方單方面變更介接格式時,就有跟對方說,若有變更的話要請事先通知,可是等到上正式機時,又在未通知的情況下變更為C格式,當然主要是之前在溝通的過程中就交惡了,所以對方其實是故意的,因為已經要上線了,變成要在很趕的時間內完成,且而對方還故意不提供介接文件。

wuewen iT邦新手 5 級 ‧ 2023-04-26 14:36:41 檢舉

另外,API變來變去我們很少遇到,都是開發前討論好了,就確定了,除非在實作的過程中發現有先前沒想到的,才會變更。因為一般人不會在需求未變更的前提下,突然改來改去。

janlin002 iT邦好手 1 級 ‧ 2023-04-26 14:53:47 檢舉

wuewen那我更慘,在沒交惡的情況下,API就有好幾種版本了,且文件也不更新,那如果交惡還得了?

wuewen iT邦新手 5 級 ‧ 2023-04-26 15:19:16 檢舉

janlin002那只能請你參考2F說的。

janlin002 iT邦好手 1 級 ‧ 2023-04-26 15:25:42 檢舉

wuewen已經是過去式了拉~~~

0
Samuel
iT邦好手 1 級 ‧ 2023-04-27 06:44:08

不是已經有類似open api Swagger文檔了嗎?
後端工程師可能就是透過註解一些資訊就好了

https://coolmandiary.blogspot.com/2021/12/net-core-web-api21swaggeropenapiapi.html

https://coolmandiary.blogspot.com/2022/01/net-core-web-api22swagger.html

我要發表回答

立即登入回答