
Security News
Meet Socket at Black Hat and DEF CON 2025 in Las Vegas
Meet Socket at Black Hat & DEF CON 2025 for 1:1s, insider security talks at Allegiant Stadium, and a private dinner with top minds in software supply chain security.
RESTful web API Documentation Generator by cobaimelan, updated by techgaun
Supply Chain Security
Vulnerability
Quality
Maintenance
License
Generates a RESTful web API Documentation. Documentation at apidocjs.com
Uses the apidoc library.
Is a fork of original gulp-apidoc because this was very urgent
/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.
*/
Install with npm
npm install --save-dev gapidoc
var gulp = require('gulp'),
apidoc = require('gapidoc');
gulp.task('apidoc', function(){
apidoc.exec({
src: "example/",
dest: "build/"
});
});
With options:
var gulp = require('gulp'),
apidoc = require('gapidoc');
gulp.task('apidoc',function(){
apidoc.exec({
src: "example/",
dest: "build/",
debug: true,
includeFilters: [ ".*\\.js$" ]
});
});
Other options checkout.
Type: String
Type: string
Default: doc/
Type: Boolean
Default: false
Type: Boolean
Default: true
Type: Array
Default: []
FAQs
RESTful web API Documentation Generator by cobaimelan, updated by techgaun
The npm package gapidoc receives a total of 27 weekly downloads. As such, gapidoc popularity was classified as not popular.
We found that gapidoc demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Meet Socket at Black Hat & DEF CON 2025 for 1:1s, insider security talks at Allegiant Stadium, and a private dinner with top minds in software supply chain security.
Security News
CAI is a new open source AI framework that automates penetration testing tasks like scanning and exploitation up to 3,600× faster than humans.
Security News
Deno 2.4 brings back bundling, improves dependency updates and telemetry, and makes the runtime more practical for real-world JavaScript projects.