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
0 answers

API docs for a generic controller that handles all requests

I need to generate api endpoints for certain database views we have in our postgres database dynamically, as we may add / delete views we don't want to update the code every time we do this. for this i have a generic controller which handles all…
opensource-developer
  • 2,826
  • 4
  • 38
  • 88
2
votes
0 answers

How to generate swagger doc automatically in ktor ,or how you write api doc in ktor

Api doc needed for our backend project. I want to generate api doc automatically like what we can do in spring_swagger. So how can we do the same thing in ktor?
zhaokh
  • 31
  • 2
2
votes
1 answer

API Documentation using OpenAPI Specification with multiple spec at a central place

We have a lot of micro services exposing their APIs and we have an API first approach. Each service has its own OpenApi3.0 spec file mostly in yaml or json format in their own git repo. However, like other companies in the wild, my team and other…
AbhishekAsh
  • 421
  • 2
  • 15
2
votes
0 answers

Flasgger failed to load API definition

I get this error message when trying to see the Swagger UI with Flasgger: ERROR in app: Exception on /apispec_1.json [GET] Traceback (most recent call last): File "/usr/local/lib/python3.6/site-packages/flask/app.py", line 2446, in wsgi_app …
Mike4
  • 103
  • 1
  • 1
  • 4
2
votes
0 answers

Automatically generating api annotations used for APIDOC

I am creating API documentation and have decided to use APIDOC (https://apidocjs.com/) for generating my documentation. I am wondering if there exists a tool that can generate the inline documentation annotations automatically from my python api…
Camille Sandidge
  • 41
  • 3
2
votes
0 answers

Adding Swagger API Documentation to Maven Site

I have a Spring Boot project and I'm using swagger to test and document the API. The project also contains a bunch of classes that are used as libraries and I'm using scala docs to document those. Is there a way to unify API docs (from swagger) and…
Rish Agarwal
  • 31
  • 1
2
votes
0 answers

Automatic API doc for Typescript & Node (koa)

I am using Typescript with Koa. Can someone tell me how can I generate automatic API documentation (not manually)? I saw there is a package tsoa (https://www.npmjs.com/package/tsoa) but I only want to have a simple API doc for my routes, so I don't…
Dionis Oros
  • 664
  • 8
  • 12
2
votes
0 answers

How to document a Rest C ++ API automatically?

I have a Rest API in C ++, ready and working correctly. It is not simple, with many files (.hpp, .cpp, .h etc.) plus many libraries and dependencies However, I would like to know if there is any way to do the automatic documentation of this API, so…
Paulinelly Oliveira
  • 21
  • 1
2
votes
2 answers

Scala Array map function documentation (PSSQ #1)

PSSQ stand for Possibly Stupid Scala Question :) Getting to know Scala a little bit, and in the obligatory Hello World example (code below) the arguments to the main function is an array of strings. object HelloWorld { def main(args:…
tmbrggmn
  • 8,680
  • 10
  • 35
  • 44
2
votes
1 answer

Documenting error codes definition in Swagger API contract

Imagine you are working under following circumstances: You have REST API modules with API documentation generated into swagger-ui.html Possible HTTP status codes for endpoints are documented well via io.swagger.annotations.* on controller method…
Zbynek R
  • 53
  • 9
2
votes
0 answers

How to add response to swagger export?

I'm using Paw to export my api calls to a swagger doc. The "requests" are being generating correctly, but not the "responses". They all just say: default no response description was provided for this operation How can I add a response? Example of…
mikelovelyuk
  • 4,042
  • 9
  • 49
  • 95
2
votes
0 answers

API call from GitHub Pages

I've created a ReST API implementation using ExpressJS and MongoDB. Currently I am hosting the API on OpenShift. I have generated a documentation using apiDoc and I'm hosting the documentation on GitHub Pages. When I open the documentation on my…
faxad
  • 421
  • 7
  • 15
2
votes
1 answer

ExpressJS, route definition, controller location and api documentation

Using expressJS 4.X with nodeJS 6.x I was previously defining my routes this way : /** * @api {get} /users/:userId Get a user * @apiName GetUser * @apiGroup User * * @apiParam {Integer} userId Users unique ID. * * @apiSuccess (Success 201)…
IggY
  • 3,005
  • 4
  • 29
  • 54
2
votes
1 answer

How to generate API html documentation from mocha BDD tests?

I worked on a project with Spring Boot java framework where guys automated API docs generation. Every time you run BDD/Integration style tests, there was api blue print file created out from mocha tests. Then it ran generate-html-from-api blueprint.…
Centurion
  • 14,106
  • 31
  • 105
  • 197
2
votes
4 answers

REST-API documentation generation from unittests

I want to automatically document my REST-API. I know, there are many tools for that, but I want to generate the documentation from my unit tests. The reason for this is, that I want the documentation to mirror, what is tested and what not.…
tgr
  • 3,557
  • 4
  • 33
  • 63
1 2 3
…
11 12