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
1
vote
1 answer

Flask restx MarshallingError incorrect formatting

Problem context I'm experiencing some unexpected behaviour with MarshallingError, when generating api documentation using flask-restx. I have a custom flask-restx field definition, like below. class EnumField(StringMixin, Raw): def…
Josmoor98
  • 1,721
  • 10
  • 27
1
vote
1 answer

APIDOCJS - Adding line break into Description

I would like to add a line break into the description. But I cannot find the proper syntax for it. What I want to achieve is all these 3 @apiError will combine under the same component. @apiError [(group)] [{type}] field [description] @apiError…
Haizad Annuar
  • 149
  • 1
  • 3
  • 14
1
vote
1 answer

In what scenario would Slate and Swagger be used together?

From this question I have seen that Swagger and Slate serve two different purposes. Swagger is an attempt at a standardized way of describing a RESTful API. Slate, on the other hand is a pretty theme for writing nice API docs. It further states…
YulePale
  • 6,688
  • 16
  • 46
  • 95
1
vote
1 answer

How can we point that field is optional / mandate in apidocjs?

We are working on expressJS and apidocJS, not able to define the optional fields in the table. we would like to update the fields are mandate or not so that users can identify the params requirements. sample code : * @apiParam {String} name The…
151291
  • 3,308
  • 7
  • 48
  • 81
1
vote
2 answers

How to hide Api-plaform Docs from Nelmio Docs

I hope someone could help me to use Api-platorm with Nelmio. I use Api-plaform and Nelmio. I need to hide the Api-platform docs from Nelmio. I need to have 3 routes: /internal -> API-Platform Docs /external -> NELMIO-Docs /admin -> NELMIO-Docs My…
krut1
  • 21
  • 4
1
vote
2 answers

Apidoc - Node.js doesn't show me @apiName

I have a problem with my documentation of API. I want to make documentation, but @apiName doesn't appear... I tried to add @appVersion, but it didn't work. This is my documentation /** * @api {post} /createBook * @apiGroup Books * @apiName…
David Kadlcek
  • 456
  • 1
  • 4
  • 18
1
vote
2 answers

how to use route to view static apidoc page with laravel

I am currently using http://apidocjs.com/ as my laravel apidoc because I am just used to it before. to view the apidoc, each time I have to drag the index.html into the browser which is quite annoying. Is it possible to make it into a static page so…
Tsuna
  • 2,098
  • 6
  • 24
  • 46
1
vote
0 answers

Significance of resource parameter in Nelmiobundles API doc parameter

What is the significance of resource parameter in NelmioBundle's APIDoc annotation? It accepts boolean value (https://symfony.com/doc/2.x/bundles/NelmioApiDocBundle/the-apidoc-annotation.html) Can someone explain the exact use case to use true /…
Mohan
  • 172
  • 1
  • 11
1
vote
1 answer

apiParam(Example) and Objects

I don't know why this won't work. The doc says: /** * @api {get} /user/:id * @apiSuccess {Boolean} active Specify if the account is active. * @apiSuccess {Object} profile User profile information. * @apiSuccess {Number} …
NicklasF
  • 863
  • 3
  • 10
  • 26
1
vote
1 answer

a specific api that search imagen in ruby didn t work to me

i am trying get the response of this api: here is some documentation of the api so when i try to call the api, the console give me the following menssage: web_1 | #"Sat, 23…
mrpepo877
  • 490
  • 6
  • 23
1
vote
0 answers

apidoc cli command doesn't work

I have tried cli apidoc command apidoc -i C:/Users/Lenovo -o C:/Users/Lenovo/apidoc, but all of them resolve into same error: error: No files found. { Path: './' } Please help.
Freweini Beyene
  • 29
  • 6
1
vote
1 answer

C# .Net4.5 API/Library method reference description inside source code

I want to retrieve the method description inside my code. I used reflection to extract the name of the methods used in a project (used MemberInfo.GetMethod() for this). Now, I want to get the description for each of the methods extracted from the…
kawser-nerd
  • 117
  • 1
  • 10
1
vote
1 answer

Set default header value for sample requests in generated documentation

I'm trying to set up sample requests for my api docs. It works fine but i need manyally set header values for every request Is there a way to define default value for header that will be sent with every sample request? I've tried to set default…
Andriy Lozynskiy
  • 2,444
  • 2
  • 17
  • 35
1
vote
1 answer

Laravel - href in ignored subfolder trouble

I have a bit of trouble with in a folder that laravel is ignoring. In my .htacces I have a line that will ignore my folder called 'doc'. Options -MultiViews RewriteEngine…
Niels Lucas
  • 739
  • 1
  • 12
  • 31
1
vote
1 answer

Swagger-codegen renames methods with same names

I have generate a swagger client api with: java -jar swagger-codegen-2.2.3/modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate -i http://localhost:8080/myproject/services/service0/swagger.json -l java -o client/myproject/java But…
Manuel
  • 205
  • 1
  • 4
  • 17
1 2 3
…
11 12