APIDOC使用教程

待我称王封你为后i 2022-05-27 13:28 423阅读 0赞

## 安装 ##

#### nodeJs Install ####

*  \[nodeJs\] - https://nodejs.org/en/download/!
 *  \[NPM\] - Installing Node.js via package manager

#### APIDOC Install ####

$ npm install -g apidoc

#### Install check ####

使用win+R快捷键打开运行窗口，在文本框中输入cmd并回车打开Windows Shell。

$ node -v  
    $ npm -v  
    $ apidoc -v

## 使用 ##

#### Run command ####

$ apidoc -i myapp/ -o apidoc/ -t mytemplate/

<table> 
 <thead> 
  <tr> 
   <th>参数</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>-i</td> 
   <td>源代码所在的位置</td> 
  </tr> 
  <tr> 
   <td>-o</td> 
   <td>生成的目标文件所在的位置</td> 
  </tr> 
  <tr> 
   <td>-t</td> 
   <td>为生成文件选择模板，可以创建和使用自定义的模板</td> 
  </tr> 
  <tr> 
   <td>-h</td> 
   <td>打印出帮助文档</td> 
  </tr> 
  <tr> 
   <td>-f</td> 
   <td>选择要解析的文件，支持正则表达式。-f参数可以使用多次，多个表达式可以对应不同的-f。如：apidoc -f “.*.js<span><span><span> " − f " . ∗ . t s " -f ".*\\.ts </span><span><span><span style="height: 0.77777em; vertical-align: -0.08333em;"></span><span>"</span><span style="margin-right: 0.222222em;"></span><span>−</span><span style="margin-right: 0.222222em;"></span></span><span><span style="height: 0.88888em; vertical-align: -0.19444em;"></span><span style="margin-right: 0.10764em;">f</span><span>"</span><span>.</span><span style="margin-right: 0.222222em;"></span><span>∗</span><span style="margin-right: 0.222222em;"></span></span><span></span><span><span style="height: 0.61508em; vertical-align: 0em;"></span><span>.</span><span>t</span><span>s</span></span></span></span></span>”</td> 
  </tr> 
 </tbody> 
</table>

#### apidoc.json ####

{
      "name": "tspdre",
      "version": "1.0.0",
      "description": "接口文档",
      "title": "平台对接",
      "url": "http://api.tt.cn",
      "sampleUrl": "http://api.tt.cn/test"
    }

发表评论取消回复

表情：

评论列表（有 0 条评论，423人围观）

还没有评论，来说两句吧...

相关阅读

相关 apiDoc 使用指南

安装 1. [安装node.js][node.js] 2. 安装apiDoc npm install apidoc -g 配置在你的项目根目录下新

短命女/ 2023年07月13日 12:17/ 0 赞/ 16 阅读

相关 API文档、apiDoc、部分使用、指南、安装、配置

> 本文主要参考 > > > > [ApiDoc官方文档][ApiDoc] 安装 1. [安装node.js][node.js] 2. 安装apiDo

布满荆棘的人生/ 2022年12月28日 04:16/ 0 赞/ 280 阅读

相关 webApi文档好帮手-apidoc使用教程

在开发后台接口的过程中，我们肯定要提供一份api接口文档给终端app。目前大多数的app的接口请求应该都是http+json的方式。但是一直苦于做不出份漂亮的api文档，

比眉伴天荒/ 2022年07月16日 15:18/ 0 赞/ 263 阅读

相关 SpringBoot非官方教程 | 第十二篇：springboot集成apidoc

> 转载请标明出处： > 原文首发于：https://www.fangzhipeng.com/springboot/2017/05/12/sb12-apidoc.html

清疚/ 2022年06月16日 00:21/ 0 赞/ 255 阅读

相关 SpringBoot非官方教程 | 第十二篇：springboot集成apidoc

> 转载请标明出处： > [http://blog.csdn.net/forezp/article/details/71023579][http_blog.csdn.ne

以你之姓@/ 2022年06月13日 08:13/ 0 赞/ 258 阅读

相关 APIDOC使用教程

安装 nodeJs Install \[nodeJs\] - https://nodejs.org/en/download/! \[NPM\] - In

待我称王封你为后i/ 2022年05月27日 13:28/ 0 赞/ 424 阅读

相关 apidoc操作

apidoc操作 apidoc -------------------- 1. 首先要确认你的系统安装了nodejs 2. install apidoc

约定不等于承诺〃/ 2022年05月23日 12:21/ 0 赞/ 135 阅读

相关【ApiDoc】官方文档(翻译)

> 本文主要参考[ApiDoc官方文档][ApiDoc] apidoc简介 apidoc是一款可以有源代码中的注释直接自动生成api接口文档的工具，它几乎支持目前主流的

不念不忘少年蓝@/ 2022年05月21日 10:06/ 0 赞/ 357 阅读

相关 idea 自动生成apidoc

一、在工具栏中找到 tool >> Generate JAVADoc ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_sh

矫情吗；*/ 2022年04月24日 12:40/ 0 赞/ 515 阅读

相关 linux 使用apidoc 生成Restful web Api文档

官方文档：[http://apidocjs.com/\example-basic][http_apidocjs.com_example-basic] 博客：[https://

朱雀/ 2022年03月06日 18:16/ 0 赞/ 307 阅读