Smart-doc优点:
无侵入的接口文档、在线文档生成器。三种生成文档方式。对于程序代码开发中只需要加注释(符合一定的语法,五分钟可掌握)就能生成在线文档。可以支持c++、java、php、node等等常见的主流语言。
Smart-doc缺点:
注重文档内容,不提供测试、mock等功能,如果要使用测试mock等功能需要先用RunApi工具手动维护接口内容,而大部分比如postman、apifox等项目管理工具都是支持直接导入swagger文档自动生成的。而且swagger本身也提供了一定的接口测试功能,如果有测试的需要的话swagger可能是更好的选择。
如何使用:
ShowDoc,该连接指向官方文档阐述,字太多,觉得我阐述的不好的可以看官方的。以下我精简归纳一下
使用脚本实现:
前提环境:windows系统、git(下载git for windows:Git - Downloading Package)、shell脚本(