c0b41 / Gulp Apidoc
📄 RESTful web API Documentation Generator
Stars: ✭ 60
Programming Languages
javascript
184084 projects - #8 most used programming language
Projects that are alternatives of or similar to Gulp Apidoc
Apidoc
RESTful API 文档生成工具,支持 Go、Java、Swift、JavaScript、Rust、PHP、Python、Typescript、Kotlin 和 Ruby 等大部分语言。
Stars: ✭ 785 (+1208.33%)
Mutual labels: api, apidoc, document
Checklist Tools Website
🍿 The perfect Checklist Website for meticulous developers.
Stars: ✭ 73 (+21.67%)
Mutual labels: api, gulp
Showdoc
ShowDoc is a tool greatly applicable for an IT team to share documents online一个非常适合IT团队的在线API文档、技术文档工具
Stars: ✭ 10,099 (+16731.67%)
Mutual labels: api, document
Health Checks Api
Standardize the way services and applications expose their status in a distributed application
Stars: ✭ 78 (+30%)
Mutual labels: api, apidoc
Express Graphql Typescript Boilerplate
A starter kit for building amazing GraphQL API's with TypeScript and express by @w3tecch
Stars: ✭ 163 (+171.67%)
Mutual labels: api, gulp
Xxl Api
A api management platform.(API管理平台XXL-API)
Stars: ✭ 803 (+1238.33%)
Mutual labels: api, document
Standards.rest
A collection of standards, specifications, etc. for HTTP API development.
Stars: ✭ 58 (-3.33%)
Mutual labels: api
React Native Doc Viewer
React Native Doc Viewer (Supports file formats: xls,ppt,doc,xlsx,pptx,csv,docx,png,jpg,pdf,xml,binary ...)
Stars: ✭ 58 (-3.33%)
Mutual labels: document
Flask Tutorial
A tutorial to build your first flask application
Stars: ✭ 58 (-3.33%)
Mutual labels: api
Rmapy
A unofficial python module for interacting with the Remarkable Cloud
Stars: ✭ 58 (-3.33%)
Mutual labels: api
Mail4delphi
Mail4Delphi uses the Indy component to send the email.
Stars: ✭ 60 (+0%)
Mutual labels: api
this package is no longer supported, use the webpack plugin instead
gulp-apidoc
Generates a RESTful web API Documentationusing the apidoc library.
How It Works
/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
Install with npm
npm install --save-dev gulp-apidoc
Usage
var gulp = require('gulp'),
apidoc = require('gulp-apidoc');
gulp.task('apidoc', function(done){
apidoc({
src: "example/",
dest: "build/"
},done);
});
With options:
var gulp = require('gulp'),
apidoc = require('gulp-apidoc');
gulp.task('apidoc',function(done){
apidoc({
src: "example/",
dest: "build/",
template: "template/",
debug: true,
includeFilters: [ ".*\\.js$" ]
},done);
});
Other options checkout.
Options
options.src
The folder to scan for apidoc documentation.
Type: String
options.dest
The folder where to output the generated files.
Type: String
Default: doc/
options.template
Custom template to use for the output files.
Type: String
options.config
Type: String
Default: options.src
options.debug
Type: Boolean
Default: false
options.silent
Type: Boolean
Default: false
options.verbose
Type: Boolean
Default: false
options.simulate
Type: Boolean
Default: false
options.includeFilters
Type: Array
Default: []
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].