最近重新要寫一下 API 文件,重新看了一下最近大家

都是怎麼解這一部分,發現很多用 swagger https://swagger.io/ https://goswagger.io/ 的格式,或是工具來處理

不管是,先寫 spec. 產生 code ,或是把文件,加註到程式裡面,

再用 swagger 的工具,產生 api 文件,這種什麼都想包,卻又什麼都做不好的方式,不是徒增文件

或是程式的複雜度,文件生成,不夠好,直接用 spec 去產生的程式,是用 template render 的方式

去產生程式的框架,如果真的有這樣的問題需要解決,那不也是包成一個函式庫比較務實嗎?

也還一大堆要修改,邏輯如果,這麼單純,大概也可以想個一勞永逸的作法,連 spec 轉 code 的這一段,也可以轉的更漂亮

東西好不好用,一試便知,就怕您自己,試也不試,網路消息,一遍遍,人云亦云,不知其所以然,也跟起風了,自己用用看

合用了,才是真的好用, 有現成刊用的函式庫,能用則用,不能再刻,適合寫成函式庫,就變成函式庫,不好使的話,

就自己刻,該寫文件,就好好寫文件,該好好寫程式,就好好寫,不要,一直追求速成,卻一事無成,或是,到處將就, 標準降低