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

Apidocjs default template not changing to new template added

I now have installed new template into my computer. https://github.com/jodacame/apidocjs-template-dark-Slate-Inspiration- as per the documentation in the above link shows, I've done the following: git clone…
112233
  • 2,406
  • 3
  • 38
  • 88
0
votes
2 answers

Parameters missing Swagger/api doc

I have a problem when update nelmio api doc from 3.0 to 3.1/3.3 on my symfony project 4.1. I have no access at the parameters that I can send in my API services in the request, I don't understand. Whether with $ request-> attributes-> all (), $…
skyhell
  • 43
  • 7
0
votes
1 answer

'apidoc' is not recognized as an internal or external command

Im working on a nodejs server and trying to generate some documentation. as Ive read here:http://apidocjs.com/, Ive added the apidoc as a dependency to the project and ran:npm install everything went well and I do see node_modules/api_doc directory,…
Omri Shneor
  • 965
  • 3
  • 18
  • 34
0
votes
2 answers

Swagger API Documentation in NodeJS

I am facing the problem in setting up Swagger. How can I implement Swagger to in my node-express project to write API Doc for existing APIs? I have looked swagger, swagger-ui, and swagger-ui-dist npm packages. But not getting the desired output. I…
Asad Marfani
  • 177
  • 3
  • 13
0
votes
0 answers

How to know the possible response when using Android framework's method?

I reference a sample code to practice Android development and some code are as follows: if (response.has("err") && response.optInt("err") != 0) { Log.e("error", "There are errors when downloading data."); } I wonder how to know what the…
Jack
  • 347
  • 1
  • 2
  • 22
0
votes
1 answer

Swagger Laravel 5.5

I am using "darkaonline/l5-swagger": "^5.5", for integrate swagger into my project. and complete whole step to configure it. Here is my function /** * @SWG\Get( * path="/clients", * summary="List clients", * operationId="listClients", * …
Ravi Gaudani
  • 186
  • 2
  • 14
0
votes
1 answer

How to make apidoc.json parameters required?

Super simple but I can't find the docs on how to mark a parameter as required when I markup my document to generate an api-doc (using the package @: http://apidocjs.com) // My APIDOC markup in my PHP doc * @apiParam {String} [type] comma delimited…
Kinglish
  • 23,358
  • 3
  • 22
  • 43
0
votes
1 answer

warn: Please create an apidoc.json configuration file

I would like to use apidoc to create API documents, but in the implementation of apidoc -i xcrm/ -o xcrm/apidoc/command prompts the following error: warn: Please create an apidoc.json configuration file. info: Nothing to do. But I created the file…
i.yuanx
  • 23
  • 1
  • 2
  • 9
0
votes
1 answer

Is apiary.io available as non-hosted solution?

Can apiary.io be used as a purely private on-premise solution as opposed to a hosted solution that is offered?
GilliVilla
  • 4,998
  • 11
  • 55
  • 96
0
votes
1 answer

create api doc with swagger

I tried generate some api via swagger without spring boot but it doesn't work my swagger controller class @Configuration @EnableSwagger2 @Controller @RequestMapping("/srs/api") public class SwaggerConfig extends WebMvcConfigurerAdapter { @Bean …
Ivan T
  • 3
  • 1
  • 6
0
votes
1 answer

Adding documentation to django app - conflict with angular

I have created documentation for my Django app using apidoc library. It creates docs using angular. App is running on Heroku. Docs are working nicely when I open index.html file, but I cannot open them via http://localhost:5000/docs. Firstly I got…
mstechly
  • 15
  • 8
0
votes
1 answer

Return entity without database Nelmio Symfony

I use Nelmio to generate automatically my api doc. I would like to return an object in responseMap which is a simple class (entity without a database associated) like this : /** * @ApiDoc( * description = "Get informations from user.", * …
Ced M
  • 13
  • 4
0
votes
1 answer

Render Views from outside the Views folder in Lumen

i'm writing an API in Lumen 5.3 and i'd like to include APIDoc for my Documentation, im rendering the APIDoc files to app/API/Docs and i'd like to be able to render the index.html from this file whenever the /docs route is hit by a Get request on…
João Serra
  • 243
  • 4
  • 14
0
votes
1 answer

Find authors of the documentation of a java standard library class

for my research I would like to know the authors of some of the Java standard library classes like Socket. I tried it with openjdk but was not that successful. I would like to see which author wrote what part of the API documentation.
Selphiron
  • 897
  • 1
  • 12
  • 30
0
votes
1 answer

API Doc apiGroup and apiName not working properly

This is my first use of apiDocs and I'm following exactly the documentation provided. The issue is that I'm defining the apiName and apiGroup but only apiGroup is shown in the output. This is my definition: /** * @apiVersion 1.0.0 * @api {post}…
GIJOW
  • 2,307
  • 1
  • 17
  • 37
1 2 3
…
11 12