撰寫API Spec example

需求分析與SPEC撰寫兼大小事

最近想寫API Spec是有些公司還是會多少要求寫API SPEC,已經有工具了,為什麼要寫???

有些人會擔心商業授權這些問題等,不太想用現成工具去產出API SPEC

不過最近發現一些新人PG不太會寫,就做此紀錄作為範本一開始開發的時候,要寫什麼模組或

是系統API的規格書,如下:


再來就是版本修正紀錄表


以在規劃功能再跟對方談,我要那些參數和相關資訊,有時候在想API功能,也要思考整個系統輪廓

login api為例


上面就是該API的SPEC寫法,是為了專門提供給其他人用或是PG調用...

 

 

 

元哥的筆記