apidocjs.com Website
apidoc / apidocjs.com Goto Github PK
View Code? Open in Web Editor NEWapidocjs.com Website
apidocjs.com Website
apidocjs.com Website
DOESN'T WORK
/**
* @api {put} /user/watched/:user/:repo watch
* @apiName watch
* @apiGroup repos
*
* @apiParam {String} user
* @apiParam {String} repo
*/
WORKS
/**
* @api {put} /user/watched/:user/:repo watch
* @apiName watch2
* @apiGroup repos
*
* @apiParam {String} user
* @apiParam {String} repo
*/
How to add a textarea instead of inputbox in the html file generated.
I need to add some json as a parameter.
I can replace the textbox with textarea in the "index.html",
but when apidoc regenerates, the changes are lost, how to add the textarea in place of input box permanently,
can I use some .css/js file for the same
I can translate apidocjs.com and pull request a file like index_es.html
Are you agree?
I want to disable autosorting of my documentation entries. Is that possible?
I think the apiPrivate doc is not correct. Here is the correction. I tried to make a pull-request but the repository does not allowed me to.
By default private APIs will be ignored. To include private APIs add --private
attribute to command line.
Exemple to create a full doc with private and non-private APIs : apidoc -o private-doc --private
Exemple to create a "public" doc with only non-private APIs : apidoc -o public-doc
Hey
According to the example_full, there should be a method to define permissions with @apiDefinePermission
. Unfortunately all I get using that is following:
warn: parser plugin 'apidefinepermission' not found in block: 1
warn: parser plugin 'apidefinepermission' not found in block: 2
warn: parser plugin 'apidefinepermission' not found in block: 3
It will work though when using just @apiDefine
. So what am I missing? Do I have to load extra plugins or what? My _apidoc.js
is a complete copy of the example, so no tampering with the markup.
Looking at the web page on a small screen, it's a problem that the left hand navigation never scrolls if it taller than the screen. It's impossible to find the bottom of the list of API parameters in that case.
Noticed using Chrome and Explorer on a Surface tablet by @robludwig
How can I add slash to groupname? It is replacing by space now.
I'm newbie on apidocjs but I would like use it to generate the API documentation. I found all options necessary except one to mark one method like deprecated.
Thank you for your help. (Great project !)
wrong project - sry
The second sentence on the website:
"Integrated is an API history, with that various API version levels can be compared. So it can be retraced what changed in the API since the last version."
...needs to be rephrased. It doesn't actually make sense
there is a way to send multiple child nodes in a json (multidimensional array) in the Request Example?
for example:
{
"person1": {"id": "1", "name1", "John", "name2": "steven", "lastname", "jhonson"},
"person2": {"id", "2", "name1", "Marly", "name2", "jay", "lastname", "jackson"}
}
At line https://github.com/apidoc/apidocjs.com/blob/gh-pages/index.html#L2314
The LICENSE link should be https://github.com/apidoc/apidoc/blob/master/LICENSE (without the .md)
When I generate my API documentation, the links to each individual API on the left hand side of the index page are currently being generated from the description of the API.
@api {post} /my/endpoint **this is the current link name**
I would like the link name to be a combination of the method type (in the above example post) and the @apiName. For this block comment:
@api {post} /my/endpoint description of API
@apiName Create Cake
I would like the link text for that API to be POST - Create Cake
Is there anyway to do this?
Could you add https (or renew your certificates) on apidocjs.com?
Hi all.
Regarding merged PR #34 it seems that the item @apiBody
is missing in the list under apiDoc-Params:
apiDoc-Params
@api
@apiDefine
@apiDeprecated
...
The content of @apiBody
is in place but the examples appear as @apiParam
instead of @apiBody
.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.