Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
apiDoc creates a documentation from API descriptions in your source code.
Documentation: apidocjs.com
Example output.
$ npm install -g apidoc
Add some apidoc comments anywhere in your source code:
/**
* @api {get} /user/:id Request User information
* @apiName GetUser
* @apiGroup User
*
* @apiParam {Number} id User's unique ID.
*
* @apiSuccess {String} firstname Firstname of the User.
* @apiSuccess {String} lastname Lastname of the User.
*/
Now generate the documentation from src/
into doc/
.
$ apidoc -i src/ -o doc/
This repository contains and example
folder from which you can generate a very complete documentation on an example api endpoint. It also contains best practice hints (in the footer.md
file).
$ git clone https://github.com/apidoc/apidoc && cd apidoc
$ npm install --prod
$ ./bin/apidoc -i example -o /tmp/doc
$ $BROWSER /tmp/doc
You can use apidoc in Docker like this:
# first build the image after cloning this repository
docker build -t apidoc/apidoc .
# run it
docker run --rm -v $(pwd):/home/node/apidoc apidoc/apidoc -o outputdir -i inputdir
C#, Go, Dart, Java, JavaScript, PHP, Scala (all DocStyle capable languages):
/**
* This is a comment.
*/
Clojure:
;;;;
;; This is a comment.
;;;;
CoffeeScript:
###
This is a comment.
###
Elixir:
#{
# 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
apiDoc will auto include installed plugins.
npm install apidoc-plugin-schema
For details and an example on how to implement your own plugin, please view apidoc-plugin-test.
Please create a new issue if you have a suggestion/question or if you found a problem/bug.
apiDoc is a collaborative project. Pull requests are welcome. Please see the CONTRIBUTING file.
pip install flask-apidoc
npm install grunt-apidoc
.npm install gapidoc
.npm install --save-dev webpack-apidoc
.0.24.0
FAQs
RESTful web API Documentation Generator
The npm package apidoc receives a total of 63,901 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
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.