1. 程式人生 > >flask + apidoc 生成接口文檔(附加一個坑)

flask + apidoc 生成接口文檔(附加一個坑)

man tps docs static get net csdn 接口 詳細

  具體使用方法見這裏 https://blog.csdn.net/lynnyq/article/details/79254290

  挺詳細的,我就不抄了。

  重點是一個坑:

  執行 python manager.py apidoc 無反應 並且沒有生成api文檔

  執行 apidoc -o static/docs 顯示Nothing to do

  執行 apidoc -o static/docs --debug 顯示一堆調試信息,說明確實工作了,但是還是啥文檔沒有

  

  苦思冥想之後、還是不解

  但是奇跡就在我給需要生成文檔的代碼文件頭部增加了文檔字符串後出現了。。。

  python將.py文件的開頭第一個字符串視為文檔字符串

  

  如果文檔字符串沒有或者為空字符串的話,apidoc竟然不起效,具體原因不明,沒有繼續追究下去,留待後人解釋

flask + apidoc 生成接口文檔(附加一個坑)