带有实时单元测试的restful json api文档生成器工具。
apihero的Python项目详细描述
阿皮赫罗
带有实时单元测试的restful json api文档生成器工具。Demo
- 实时测试单元。
- 基于文件的结构。
- 模板支持(基于Mako)。
- 用json和markdown格式化。
如何使用
从PIP安装:
sudo pip install apihero
只需在python3上工作,如果在ubuntu等发行版上不工作
sudo apt install python3-pip sudo pip3 install apihero
现在签出APIHero sample并学习如何创建自己的文档。 对于文档目录上的构建输出cd,只需运行apihero。
待办事项
- 本地化支持。
- 模板设计更容易。
- 外部页面。
- 搜索。
- 响应语法突出显示。
- 单页生成。
- 为参数添加remember选项,以保留最后一个值。
- 测试单元的预加载程序。
- 完成ApiHero文档。
- 添加可配置的cli参数。
- 添加一个级别类别。