【文件属性】:
文件名称:gulp-apidoc:RESTful Web API文档生成器
文件大小:6KB
文件格式:ZIP
更新时间:2021-02-03 16:48:16
gulp api apidoc document GulpJavaScript
不再支持此软件包,请改用
-apidoc
使用库生成RESTful Web API文档。
这个怎么运作
/path/api/stuff.js :
/**
* @api { get } /user/:id Request User information
* @apiName GetUser
* @apiGroup User
*
* @apiParam {Number} id Users unique ID.
*
* @apiSuccess {String} firstname Firstname of the User.
* @apiSuccess {String} lastname Lastname of the User.
*/
安装
用安装
npm install --save-dev gulp-apidoc
用法
var gulp = require ( 'gulp' ) ,
apidoc = require ( 'gulp-apidoc' ) ;
gulp . task ( 'apidoc' , function ( done ) {
【文件预览】:
gulp-apidoc-master
----example()
--------header.md(686B)
--------apidoc.json(475B)
--------example.js(2KB)
--------_apidoc.js(3KB)
--------footer.md(127B)
----index.js(993B)
----package.json(735B)
----readme.md(2KB)
----gulpfile.js(218B)
----.gitignore(43B)