APIDOC使用教程

安装

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/

参数	描述
-i	源代码所在的位置
-o	生成的目标文件所在的位置
-t	为生成文件选择模板，可以创建和使用自定义的模板
-h	打印出帮助文档
-f	选择要解析的文件，支持正则表达式。-f参数可以使用多次，多个表达式可以对应不同的-f。如：apidoc -f “..js " − f " . ∗ . t s " -f ".\\.ts "−f".∗.ts”

apidoc.json

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

APIDOC使用教程相关推荐

apidoc使用教程-编写漂亮的api文档
apidoc使用教程更多干货 React 入门实战(干货) 分布式实战(干货) spring cloud 实战(干货) mybatis 实战(干货) spring boot 实战(干货) 构建中小型 ...
webApi文档好帮手-apidoc使用教程
在开发后台接口的过程中,我们肯定要提供一份api接口文档给终端app. 目前大多数的app的接口请求应该都是http+json的方式. 但是一直苦于做不出份漂亮的api文档,用word写,也太丑了.. ...
Linux系统安装、使用apidoc教程
apidoc安装教程: 1.首先要确定是否已经安装了node.js,如果未安装可以参考node.js的安装教程:https://blog.csdn.net/ba_qi/article/details/ ...
企业级 SpringBoot 教程（十二）springboot集成apidoc
首先声明下,apidoc是基于注释来生成文档的,它不基于任何框架,而且支持大多数编程语言,为了springboot系列的完整性,所以标了个题. 一.apidoc简介 apidoc通过在你代码的注释来生 ...
快速根据注释生成接口文档网页工具——Apidoc的使用教程
环境: 操作系统 CentOS Linux release 7.6.1810 (Core) 64位服务器环境 "腾讯云"服务器 1,安装Node.js的npm工具环境: ...
java apidoc案例_JAVA APIDOC 文档使用教程
Windows下载: https://nodejs.org/dist/v8.11.3/node-v8.11.3-x64.msi Mac下载: https://nodejs.org/dist/v8.11 ...
Apifox 生成接口文档教程与操作步骤
接口文档自动生成本文主要介绍使用 apifox 如何生成接口文档,附上详细的使用教程和操作步骤. 使用Apifox 的可以自动生成接口文档.本文会给大家介绍下如何使用Apifox 来自动生成所需的接 ...
JEB2插件教程之一JEB2AutoRenameByTypeInfo.py
JEB2发布有段时间了,相比于JEB1来说功能强大了很多,但是API也发生了巨大的变化,不仅是定义上也包括架构上,这给我们移植或者是新编写插件带来了一定不便, 目前也还没看到详细一些的API分析教程. ...
YII2日常所用的教程
YII2日常所用的教程作者:Terry,2014年开始使用Yii2,用yii2做了几个线上项目,包括:外贸B2C电商,ERP,营销系统,统计系统等.本博客致力于研究Yii2的源码,研究他的内在机制, ...

APIDOC使用教程

安装

nodeJs Install

APIDOC Install

Install check

使用

Run command

apidoc.json

APIDOC使用教程相关推荐

最新文章

热门文章