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

Generate interactive API docs from Tornado web server code

I have a Tornado web server that exposes some endpoints in its API. I want to be able to document my handlers (endpoints) in-code, including description, parameters, example, response structure, etc., and afterwards generate an interactive…
mllm
  • 17,068
  • 15
  • 53
  • 64
4
votes
0 answers

Publicly Defined APIDoc Definitions

I am using apiDoc for documentation in Sails.js app. And, last week I saw someone define responses being used by multiple controllers in a file named api_definitions.js Example /* * @apiDefine UserSuccessExample * @apiSuccessExample…
user3994005
4
votes
1 answer

Yii2 apidoc won't let me add my project and the yii framework to the same docs.

I'm building documentation for a project written in yii2 using yiisoft/yii2-apidoc (#0.2.4). I have built a shell script to publish the docs and it works fine when I am only including the project files and my own cms codebase which is pulled in via…
Sean Toru
  • 349
  • 2
  • 17
4
votes
3 answers

Does Swagger have the ability to support API change history, or is there an open-source library that does?

I am using Swagger Editor to generate YAML/JSON code that will display the details of my API in Swagger UI. I would like for the consumers of my API to be able to view a revision history (ex. an added field, a field changed from 'optional' to…
Abby Stickler
  • 41
  • 1
  • 4
3
votes
0 answers

How to uninitialize (destroy) Redoc?

I am using Redoc to generate API docs GUI. The application is made as single page application including API docs. But there is an issue in the Redoc behaviour. When Redoc is initialized and rendered and I click on another page which is longer than…
Honza
  • 939
  • 2
  • 11
  • 28
3
votes
0 answers

Spring boot project add login endpoint to swagger API Doc (springdoc-openapi-ui)

I'm using java 17 and spring 2.6.3 and this package : springdoc-openapi-ui:1.6.5 and I was wondering how I can add login endpoint to the swagger documentation ? I'm using Spring's security package and login endpoint is provided for me but still I…
Majid Abdolhosseini
  • 2,191
  • 4
  • 31
  • 59
3
votes
1 answer

how to include common responses to raml resource

I have raml docs, and try to add new API's docs to that docs. I gone through basic RAML docs. I have raml file as. #Filename: base.raml title: Test RAML documentation: - title: Test RAML docs first time :) content: This is RAML…
Nilesh
  • 20,521
  • 16
  • 92
  • 148
3
votes
1 answer

APIDocJS - Generating Navigation Links Using Method Type and @apiName Instead of Description

When I generate my API documentation, the links to each individual API on the left hand side of the index page are currently being generated from the description of the API. @api {post} /my/endpoint **this is the current link name** I would like…
Lloyd Banks
  • 35,740
  • 58
  • 156
  • 248
3
votes
1 answer

Linking to package generated via Sphinx-apidoc

When using sphinx-apidoc to generate .rst files, the output produce does not contain any labels: dessn.examples package ====================== .. automodule:: dessn.examples :members: :undoc-members: …
Samreay
  • 313
  • 3
  • 11
3
votes
1 answer

Toggle Javadoc block comment in Eclipse

I'm moving my API documentation from a flat text file in Github to Javadoc comments using apidoc. So, I already have API output examples that I'd like to write in the javadoc syntax. I need to add the little * at the beginning of each line without…
singe3
  • 2,065
  • 4
  • 30
  • 48
3
votes
1 answer

Writing an api-doc for Swagger

I'm trying to use the Swagger UI, and it says that I should begin by writing an api-doc that describes the exact api for a REST api. The problem is that I have no idea what this means. Is this document written in plain English? Or is there a certain…
lmo523
  • 459
  • 1
  • 7
  • 18
3
votes
2 answers

How do I add more information about APIs in Swagger?

I included swagger-springmvc in my project and managed to get the Swagger UI working, but right now there's very little information about the APIs in the UI. All I see is information extracted through reflection. This is what a controller method…
stackular
  • 1,431
  • 1
  • 19
  • 41
3
votes
2 answers

django-rest-swagger isn't parsing/translating Markdown docstring into HTML code

So far I know django-rest-swagger supports docstring in Markdown syntax from v0.1.10. But when i try to see the documentation, it is shown as plain text instead of parsing and transaling it to HTML code. I'm…
trinchet
  • 6,753
  • 4
  • 37
  • 60
3
votes
2 answers

Parsing Jackson annotations with Swagger

By default, Swagger parses a class's data members in order to document the objects used as parameters or returned by a given web service. If you're using Jackson, the Jackson annotations provide a much more accurate description of the API. Does…
Eyal
  • 3,412
  • 1
  • 44
  • 60
2
votes
1 answer

OpenAPI Spec: what is suitable license for a private and internal OpenAPI doc?

My company uses Open API Spec to organize the doc for internal APIs and render it through UI tools, for example, redoc.ly or Swagger. The API doc is managed as a private git repo and will never be released to the public. License for private API…
Ryan Lyu
  • 4,180
  • 5
  • 35
  • 51
1 2
3
…
11 12