使用API文件生成工具 sphinx

python第三方庫sphinx可以自動化為restful api生成文件，使用步驟如下所示：

pip install sphinx

mkdir document

配置方式有兩種：

可以使用sphinx-quickstart命令配置，基本上一路按回車就可以，最後會生成一下檔案和目錄：

2. 使用

sphinx-apidoc命令

可以用--help檢視引數列表

例如：3.修改conf.py

將工程目錄新增到模組搜尋路徑，生成文件時是需要。

import os

import sys
sys.path.insert(0, os.path.abspath(r'..'))

直接執行make會給出可以make的列表

生成html文件，可以執行make epub 或 make html

生成檔案在_build目錄, 兩種格式結構類似，但make html的格式有搜尋功能，本人比較喜歡。

使用swagger生成API文件

有時候乙份清晰明了的介面文件能夠極大地提高前後端雙方的溝通效率和開發效率。本文將介紹如何使用swagger生成介面文件。swagger本質上是一種用於描述使用json表示的restful api的介面描述語言。swagger與一組開源軟體工具一起使用，以設計 構建 記錄和使用restful web服...

告別手寫 API文件生成工具推薦

隨著api的發展以及需求的日益增加，對api文字文件的需求與隨之而來。相信許多開發人員都遇到過編寫api文件方面的問題及煩惱。你是否還通過手寫的方式來生成和編寫這些文件呢？那麼你就out啦！話說工欲善其事必先利其器，本文分享8款非常好的api文件生成工具給大家。web api文件工具列表 swagg...

告別手寫 API文件生成工具推薦

隨著api的發展以及需求的日益增加，對api文字文件的需求與隨之而來。相信許多開發人員都遇到過編寫api文件方面的問題及煩惱。你是否還通過手寫的方式來生成和編寫這些文件呢？那麼你就out啦！話說工欲善其事必先利其器，本文分享8款非常好的api文件生成工具給大家。web api文件工具列表 swagg...