Inline Documentation for RESTful web APIs. apiDoc creates a documentation from API annotations in your source code.
Questions tagged [api-doc]
169 questions
0
votes
1 answer
Static API docs with source2swagger
source2swagger generates a swagger spec with all apis in one json file. Can swagger-ui actually use that? When I explore the generated json file with swagger-ui, it tries to read the api descriptions from their paths in the spec, instead of using…
Joe Beuckman
- 2,264
- 2
- 24
- 63
0
votes
1 answer
Set 'parameters' annotation in NelmioApiDocBundle
I create an API RESTfull using Symfony2.1 with FOSRESTBundle and I am using NelmioApiDocBundle to generate automatic documentation.
I have a PUT request in which the user should send one parameter, but I don't need to create a Form for this purpose.…
Fernando P. G.
- 191
- 2
- 15
0
votes
1 answer
Cannot use REST comments in Swagger
I have downloaded swagger ui and experimenting it locally. It works fine in scenarios like "path", "body" , and "query" . But most of my use cases use rest comments.
i.e /resourcePath/;tags
URI to retrieve the tags of a specific resource.
When…
Subash Chaturanga
- 814
- 2
- 10
- 20
-2
votes
1 answer
When I wrote an api document, I don't know how to write request and response side
I made some code for sending data to other url and that was written with spring and java, using 'httpclient' class. About that code please check this question that I made
how to get http status value?
I have a problem with request and response of…
honey.E.seo
- 1
- 2