Generates a RESTful web API Documentation.
Documentation at apidocjs.com.
Example output.
npm install apidoc -g
/**
* @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.
*/
apidoc -i example/ -o doc/
Creates from input files in example/ a documentation in path doc/.
C#, Go, Dart, Java, JavaScript, PHP (all DocStyle capable languages):
/**
* This is a comment.
*/
CoffeeScript:
###
This is a comment.
###
Erlang:
%{
This is a comment.
%}
Perl
#**
# This is a comment.
#*
=pod
This is a comment.
=cut
Python
"""
This is a comment.
"""
Ruby
=begin
This is a comment.
=end
grunt-apidoc npm install grunt-apidoc.
Please add issues if you have a question or found a problem. Pull requests are welcome too!
A chat about apiDoc is on Gitter.
Copyright (c) 2013-2014 inveris OHG
Author Peter Rottmann rottmann@inveris.de
Licensed under the MIT license.
0.7.2
FAQs
RESTful web API Documentation Generator
The npm package apidoc receives a total of 33,557 weekly downloads. As such, apidoc popularity was classified as popular.
We found that apidoc 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
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.