Smart-doc的脚本生成在线文档(精简官方文档描述)

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脚本(

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值