Stack Overflow
Stack Overflow

Questions tagged [api-doc]

Inline Documentation for RESTful web APIs. apiDoc creates a documentation from API annotations in your source code.

169 questions
0
votes
1 answer

How have two @apiName functions in one class file in apiDocJs?

I have a servlet that can handle multiple paths and do different things based on that. I want to document the different functions in the class file using http://apidocjs.com but cannot figure out how to get two to show up. When I try this (see…
Don Rhummy
  • 24,730
  • 42
  • 175
  • 330
0
votes
1 answer

Nodejs/apidocjs: How do I render the generated documentation at a specific url without a template

I am writing apidocs for a nodejs project someone else wrote. I would like the documentation page to be displayed when someone visits "myurl.com/docs/api". My documentation directory is being placed under "app/public/app/docs/apidoc/" and I am…
shanahanjrs
  • 1
  • 3
0
votes
1 answer

How to use springfox in a less invasive way?

I want to use springfox to generate API docs in a springmvc project. But by using springfox, I must add java annotation to controllers and models, which is very invasive. So what can I do to use it in a less invasive way? Or what else frameworks can…
Shildon
  • 11
  • 5
0
votes
1 answer

Redirecting to API/Docs/index.html folder in Lumen

So i have an API created with Lumen with some documentation done with Apidoc outside of the public folder and i'd like to serve it when the user goes to the URL http://apidomain.com/docs This is the structure of the app ProjectRoot ->API ->Auth …
JonnySerra
  • 1,044
  • 3
  • 13
  • 27
0
votes
2 answers

Index.html file generated by apidoc.js shows a 404 error after deploying asp.net web api app to server

I used apidocjs to setup the documentation of my asp.net web api app. Everything works fine on my machine when I run my web api in visual studio but not on the server I deployed the app to. I get a 404 error when I navigate to the index.html…
Oluwatobi Akinseye
  • 46
  • 1
  • 6
0
votes
2 answers

How to find out some specific meaning of something in ZF1 api doc

A Zend_Form like this: class Application_Form_Registration extends Zend_Form { public function init() { /* Form Elements & Other Definitions Here ... */ $$this->setMethod('post'); //first name …
Hao
  • 6,291
  • 9
  • 39
  • 88
0
votes
1 answer

apidocjs not returning anything in response

I have installed 'apidoc' after installing 'npm' and 'node' for my API documentation by the help of following command: npm install apidoc -g After installing apidoc globally, I simply ran below command on my project directory (assuming apidoc will…
Shadman
  • 755
  • 2
  • 11
  • 19
0
votes
2 answers

Swagger editing api-docs?

I'm new to developing rest web services and now, I'm trying to add authenication via this url: http://developers-blog.helloreverb.com/enabling-oauth-with-swagger/ Unfortunately, I'm stuck on the first step, when it says to edit the resource listing,…
Don Kane
  • 3
  • 3
0
votes
1 answer

node.js apidoc how to configure index.html for doc page?

Im new at node, implementing documentation module, I have some test file on /lib with documentation comments from example. I run ./node_modules/apidoc/bin/apidoc -i lib / -o docs/apidoc it responds >info:Done now my basic question, how to access…
manuelBetancurt
  • 15,428
  • 33
  • 118
  • 216
0
votes
1 answer

Display API documentation as an IPython notebook

We have a Python project where our documentation is currently spread across three places: we have example Python files, we have Sphinx docs (some of which are generated from IPython notebooks) and we have IPython notebooks. We are considering…
Jack Kelly
  • 2,214
  • 2
  • 22
  • 32
0
votes
1 answer

Grape-Swagger not listing methods contained in a grape-based API

I'm using the grape-swagger gem and I'm being unable to get a Grape-based API properly described in Swagger. Using: grape (0.11.0) and grape-swagger (0.10.1) When I enable the Swagger json listing I get this output listing all endpoints but not the…
Jorge Diaz
  • 2,503
  • 1
  • 14
  • 15
0
votes
0 answers

Unrecognized options "type" under "nelmio_api_doc.sandbox.authentication"

Having problem to call api form nelmio api doc, api work from Postman extension config.yml fos_rest: body_converter: enabled: true body_listener: decoders: json: fos_rest.decoder.json routing_loader: …
Avinash
  • 81
  • 2
  • 9
0
votes
1 answer

LiveScript API-Doc creation?

With JavaScript I used JSDuck, what should I use for LiveScript? Seems like comments aren't preserved in the JS-source.
K..
  • 4,044
  • 6
  • 40
  • 85
0
votes
2 answers

Where to place package.json for apiDoc

I am looking to use apiDoc to document a WebAPI interface. The apiDoc documentation mentions the use of a package.json file to specify things like the project name and latest API version. Unfortunately, I can't get this to work. Where should this…
Darren Oster
  • 9,146
  • 10
  • 48
  • 66
0
votes
1 answer

ASP.NET Web API Help Page documentation with Doxygen. Is it possible?

Is it possible to generate this type of API documentation with Doxygen. If so how? I do have all my controllers XML commented.
Sartorial
  • 173
  • 1
  • 8
1 2 3
…
11
12