利用 APIDOC 生成 RestFul 风格的 API 文档

    本文参考博客:https://www.jianshu.com/p/9353d5cc1ef8

    apidoc是一款可以有源代码中的注释直接自动生成api接口文档的工具,它几乎支持目前主流的所有风格的注释。例如:Javadoc风格注释(可以在C#, Go, Dart, Java, JavaScript, PHP, TypeScript等语言中使用)

    本文只讲述 APIDOC 的基本用法!!!!

    环境:win7 

   首先需要使用 npm 安装 apidoc(前提是安装了node.js,请自行安装), 在DOC中输入以下命令

npm install apidoc -g

   apidoc的使用很简单,只是通过一些简单的注释 来生成API文档,这里直接上例子

   百度网盘: https://pan.baidu.com/s/1OdCGvdNMQuePfpzmkbrZog 提取码: 6gs7

   CSDN: https://download.csdn.net/download/zcf980/10948648  (抱歉!!下载积分无法自定义,喜欢的可以支持)

   模板使用方法:下载模板并解压,共两个文件,一个配置文件apidoc.json和一个需要生成 API 的 .java 文件

                      

  在DOC中输入以下命令 

apidoc -i D:\apidocDemo -o D:\api

  其中 -i 为输入路径, 即需要生成API的文件所在位置, -o 输出路径,即生成API文档保存的位置

  执行命令后即生成了 API 文档

  

  

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值