# API文件待修正項目 ## 1. Request同樣需要範例,而且要把限制說明清楚 ![](https://i.imgur.com/gp3kUyb.png) ## 2. Response格式請統一 ![](https://i.imgur.com/9bxH5Ya.png) ![](https://i.imgur.com/AnGnekK.png) ## 3. Response子物件建議分開寫,會比較清楚 原來 ![](https://i.imgur.com/fdNtTyp.png) 範例 ![](https://i.imgur.com/wS6ulDP.png) ![](https://i.imgur.com/9eepUAE.png) ## 4. 航班和舤班不需要分頁嗎?資料量不多的關係嗎? ## 5. API名稱可以更簡潔 因為Method [GET][POST]己經可以說明資料代表的動作 EX:[GET] reponseShift=>[GET] Shift,[GET] responseShiftReserver=>Shift/Reserve,[POST] /creatOrder=>[POST] /Order,[PUT] /cancleOrder=>[Delete]/Order ## 6.可以針對Order的各項API多做一些說明,比如名額如何鎖定,如何釋放,驗證條件為何,什麼情況下不能操作 提供一些說明範例 ![](https://i.imgur.com/QoPX0Tp.png) ![](https://i.imgur.com/TCDpnYX.png) ![](https://i.imgur.com/5Wbui1a.png)