flask + apidoc 生成接口文档(附加一个坑)

  具体使用方法见这里 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竟然不起效,具体原因不明,没有继续追究下去,留待后人解释

 

posted @ 2018-04-08 16:52 Mr.Dolphin 阅读(...) 评论(...) 编辑 收藏