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
7
votes
4 answers

How to copy .NET API documentation?

If a class implements a method defined in an interface you can choose whether you duplicate the documentation or reference it with . public interface IPerformer { /// /// Do something useful. /// …
deamon
  • 89,107
  • 111
  • 320
  • 448
7
votes
1 answer

How will Swagger 2.0 handle generics in parameters or return types?

I am using Swagger 2.0 for documentation generation. In my controller class, I have some operations like: public Page getEmployees(Pageable pageable) {....} Swagger document generated for response of the operation above: "responses" : { …
Sunil Kumar
  • 5,477
  • 4
  • 31
  • 38
7
votes
1 answer

Swashbuckle SwaggerResponse not showing response model

I am using the latest version of Swashbuckle 5.1.3 and noticed there is a new attribute SwaggerResponse which allows you to document a response type for each response code. For example: (https://github.com/domaindrivendev/Swashbuckle/issues/175 <…
Dr Schizo
  • 4,045
  • 7
  • 38
  • 77
6
votes
0 answers

How to search old/legacy TensorFlow documentations efficiently?

I need to check the TensorFlow API documentation for an old TF version (0.12.1). The website points me to the GitHub branches. I was able to find my information by checking the code in the sub-packages of the respective branch. However, I am looking…
whiletrue
  • 10,500
  • 6
  • 27
  • 47
6
votes
1 answer

How to set array response in api-doc?

I tried to generate a API document by apidoc If my response is a array like [ {"id" : 1, "name" : "John"}, {"id" : 2, "name" : "Mary"} ] How could I set in @apiSuccess? I had try Object[] but did not know how to set the field name. Thanks.
wilson Liu
  • 579
  • 2
  • 8
  • 18
5
votes
2 answers

How to Generate REST API documentation with Typescript and Node?

Can I use https://github.com/TypeStrong/typedoc to create REST API docs like https://apidocjs.com/? Any suggestions on how to reuse TypeScript types to generate REST API docs are welcome (Using Next.js)
Srdjan Stajic
  • 69
  • 1
  • 5
5
votes
1 answer

Required validation not working in laravel darkaonline swagger UI

I am using darkaonline/l5-swagger: 7.0 for generate swagger UI which based on OpenApi 3.0. But the problem is required validation only works for path params and not with form-data properties. I tried adding required property names in an array but it…
Randika
  • 683
  • 3
  • 11
  • 32
5
votes
1 answer

Flattening RequestParam Object in OpenApi 3

I am migrating from swagger 2 to OpenApi 3. Swagger 2 Sample Code @ApiOperation(value = "", nickname = "") @GetMapping public List findEmployees(@Valid Dto dto) { return…
Sumit
  • 121
  • 1
  • 9
5
votes
1 answer

Why api response body is not showing in postman app generated documentation?

I am testing apis usng postman continuously and then generating api documentation using postman app. But problem is that documentation is not displaying api response which i am receiving in postman console. Here is the response which i am receiving…
Fahad Hassan
  • 781
  • 10
  • 20
5
votes
1 answer

How to convert apiDoc to postman collection?

I have a nodejs project with many requests implemented and well documented by apiDoc, and I want to create a Postman collection from it! > example: /** * @api {GET} config/updates Updates - Get the latest event updates * @apiGroup Config…
Krausz Lóránt Szilveszter
  • 373
  • 1
  • 9
  • 13
5
votes
4 answers

Symfony - The annotation was never imported

I'm using Symfony framework and have intention do add auto-documentation engine to RESTful api of my project. After some searching I've found apidoc engine (http://apidocjs.com/). It works pretty simple: you have to add some annotations for every…
Alex Zhulin
  • 1,239
  • 2
  • 22
  • 42
5
votes
1 answer

how to make apidocs use packages instead of modules in sphinx-apidoc

I'm using docstrings to document python code and sphinx-autodoc to generate apidoc HTMLs. The structure of my packages is as follows: mainpackage.subpackage.module, I want apidocs to link to classes from a module as mainpackage.subpackage.Class and…
niedakh
  • 2,819
  • 2
  • 20
  • 19
5
votes
2 answers

How to host jsdoc / apidoc on Express.js

Im using http://apidocjs.com/ to create public documentation for an Express.js API that I am building. My question is, how do I use Express.js to route and serve the documentation? Here's my Express server setup: /** Load config into globally…
RachelD
  • 4,072
  • 9
  • 40
  • 68
4
votes
2 answers

APIDOC - Remove Sample Request

Hey there I'm trying to remove/hide the sample request form from my apiDoc. I'm not using the sampleUrl tag on my package.json config, on the api_porject.json this property is set to false. But still, on every request that there's the sample…
Pedro Oliveira
  • 41
  • 1
4
votes
1 answer

OpenAPI generator: wrong format for the example value of date datatype. Is it possible to customize?

I am using openapi-generator of the latest version (4.2.2) for generation of Java Spring API. Configuration looks like this: openApiGenerate { generatorName = "spring" inputSpec = "${projectDir}/src/main/resources/api/users-spec.yaml" …
NomaD
  • 111
  • 1
  • 1
  • 7
1
2
3
…
11 12