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
2
votes
1 answer

Unable to generate the documentation using apiDocjs

Went through couple of tutorials and documentations, including main documentation here.Following it, created two files : 1) example.js var currentUser={ name='Mary' }; /** * @api {get} /user/ Request User information * @apiName GetUser * @apiGroup…
lazy rabbit
  • 1,076
  • 3
  • 11
  • 29
2
votes
2 answers

Bypass Annotation Symfony2

I'm currently building a RESTful API using Symfony2. In order to create a simple and clean documentation, I wish to use apidoc.js (I really would prefer to use this one, but if you have anything else to auto generate api documentation feel free to…
Paul Gabriel
  • 45
  • 8
2
votes
2 answers

APIDOCJS - How to create versioning

I been playing with APIdoc.js for the past few days and I can't seem to figure out how to make versioning work. I understand I need to save my old APIDOC comment code into another file with @APIVersioning on the new / old code according to APIDOC.…
Joshua Dalley
  • 339
  • 3
  • 6
  • 23
2
votes
1 answer

Sails.js + apidocjs + grunt - auto generate documentation

I'm new to Sails.js and Node.js and I have problems with creating documentation for my application. Here's my steps: installed apidoc by: npm install apidoc -g installed grunt module: npm install grunt-apidoc --save-dev added…
Tomasz
  • 2,051
  • 3
  • 31
  • 64
2
votes
1 answer

FOSRESBundle routes with @QueryParam

I'm using Symfony 2.3.4 and FOSRestBundle 0.13.1. I have configured the routes to be auto-generated by the FOSRestBundle. Eveything works great until I add the @QueryParam annotation to any method. This annotation changes the route and instead of…
flivan
  • 473
  • 4
  • 8
1
vote
0 answers

How to define apiParam json object on apidoc

I want to define object apiParam for example let data = { id:null, status:null, category:null } The variable data is a json object I want to show object params on apiParam.
Fatih Doğan
  • 417
  • 1
  • 4
  • 16
1
vote
2 answers

How to add headers in the curl request example of the postman API document

How to add a given header to an api request example in the postman api document. I am using 'Content-Type': 'application/json' in the headers of postman to test my api requests. However, after generating the postman document from my api…
Amirov
  • 66
  • 4
1
vote
0 answers

Swagger not displaying end points

Hello I am creating API doc for my node API using swagger but my screen doesn't show any end point my code is as below: in app.js: const swaggerJsonDoc = require('swagger-jsdoc') const swaggerUI = require('swagger-ui-express') const apiDoc =…
DevError404
  • 129
  • 2
  • 14
1
vote
0 answers

Open MarkLogic API Doc context-sensitive help in VSC

Is there an xquery-ml context-sensitive help feature with the MarkLogic visual studio code extension? I am looking for a compatible feature like this one for sublime text https://packagecontrol.io/packages/MarkLogic#open-marklogic-api-docs It will…
XCELERENT - I want to dance
  • 523
  • 2
  • 7
1
vote
0 answers

apiDoc Path Not Open after generating

After creating two routes like user & auth route in a node and express.js I generate apidoc documentation. It shows successfully generate api_docs folder - But when I access the apidoc route then it show this error - My apidoc module current…
Kazi Rahamatullah
  • 361
  • 1
  • 4
  • 17
1
vote
0 answers

Can't publish API doc to GitHub Pages

Here's my .github/workflows/publish-apidocs.yml: name: Publish API docs on: push: branches: - main jobs: build-and-deploy: runs-on: ubuntu-latest steps: - name: Checkout ️ uses: actions/checkout@v2.3.1 …
Artem Laptiev
  • 53
  • 3
1
vote
0 answers

How can I generate html from OpenAPI 3.1 schema?

I've got a schema in OpenAPI 3.1 spec that was released recently. How can I generate html from that? I used to run openapi-generator generate -i PathToMyInputDefinitionFile.yaml -g html -o /PathToOutputFolder But as far as I can see,…
Alex Ivanov
  • 31
  • 3
1
vote
1 answer

Can't install "laravel-apidoc-generator" due to "Conclusion: remove doctrine/inflector 2.0.3"

I'm trying to install laravel-apidoc-generator (https://github.com/mpociot/laravel-apidoc-generator) in my latest Lumen REST API. This is my Lumen version: Lumen (8.0.1) (Laravel Components ^8.0) This is my PHP version: PHP 7.3.22. When I'm trying…
Chanaka De Silva
  • 67
  • 2
  • 9
1
vote
1 answer

oracle UCM view rejection comments

in oracle webcenter content workflows , when a user reject a file and type a comment in the rejection reason , how the next user will interact with this file in the workflow can view the rejction comment ? i can't find anyway to view this rejection…
osfar
  • 401
  • 1
  • 4
  • 23
1
vote
0 answers

Dynamically construct url in swagger for each operation

I Check the swagger and we can have URL dynamically for various site based on Server specified. But i have doubt whether is it possible to construct URL dynamically for each operation similar like this http://{serverurl}/{tagName}/{operation} I know…
Barani Dharan
  • 13
  • 3
1 2 3
…
11 12