Generates a RESTful web API Documentation.
Changes from previous version visit CHANGELOG.md
apiDoc creates a documentation from API descriptions in your source code.
Documentation at apidocjs.com or as Docset.
Example output.
Because of my limited time i need one or more devs that could build and maintain a "Send Sample Request Plugin".
The Plugin should be loose coupled to the template, so it should be a separate project. This Plugin should send example data to an API-Endpoint and process the response. Supported formats should be JSON, XML, whatever.
Many issues belong to the current (unmaintained) plugin, (Milestone: Send Sample Request Plugin)(https://github.com/apidoc/apidoc/milestone/4) If you want ot work on this, please send me a PM.
$ 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/
.
More examples and best practice hints: EXAMPLES.md
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.
###
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
pip install flask-apidoc
npm install grunt-apidoc
.npm install gapidoc
.npm install gulp-apidoc
.npm install gulp-apidocjs
.For details and an example view apidoc-plugin-test
Please add issues if you have a question or found a problem. Pull requests are welcome too!
A chat about apiDoc is on Gitter.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。