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

Slate vs Swagger - Which is better and which have more options?

I have to document my API's. I have to use any one of them Slate Or Swagger. I want to know which one have more options, pros and cons, which one is better.
Sariban D'Cl
  • 2,197
  • 2
  • 28
  • 42
28
votes
2 answers

Django rest APIs, automate documentation?

I tried documenting the APIs while writing viewsets and using django rest docs. I am having the following problems: if I try to send values for reverse related field, it takes list of values, but when sending the data in Form-data, it comes as a…
Ravi Bhushan
  • 942
  • 2
  • 11
  • 19
27
votes
6 answers

How to generate a static html file from a swagger documentation?

I have created a Swagger documentation with a yaml file under: api/swagger/swagger.yaml Now I want to share a static HTML document with its definition, yet it was stated on the swagger project, that they don't plan to support HTML generation at…
k0pernikus
  • 60,309
  • 67
  • 216
  • 347
19
votes
1 answer

How do I use the swagger models section?

Inside the Swagger API Documentation there is inside the json beside the apis array a model object entry but no documentation about it. How can I use this "models" part? { apiVersion: "0.2", swaggerVersion: "1.1", basePath:…
Thomas R.
  • 375
  • 1
  • 3
  • 12
18
votes
3 answers

Generate WebAPI documentation in swagger json format

I have created a WebAPI using .Net 4.5 and want to document this API using Swagger. I have added swagger-ui in my .Net project. Now when i browse to ../swagger-ui/index.html it successfully opens pet store api-docs (json) in swagger UI format. My…
theGeekster
  • 6,081
  • 12
  • 35
  • 47
18
votes
6 answers

Sphinx apidoc section titles for Python module/package names

When I run sphinx-apidoc and then make html it produces doc pages that have "Subpackages" and "Submodules" sections and "module" and "package" at the end of each module/package name in the table of contents (TOC). How might I prevent these extra…
ecoe
  • 4,994
  • 7
  • 54
  • 72
17
votes
2 answers

Autogenerate documentation for Python project using setuptools

I have created a demo project which uses setuptools and has the following structure: project/ |- pizza/ | |- __init__.py | `- margherita.py | |- README.rst |- setup.cfg `- setup.py I'm trying to autogenerate documentation for this…
Remco Haszing
  • 7,178
  • 4
  • 40
  • 83
11
votes
1 answer

What does "Remotable" mean?

What do the Android API docs mean when they talk about a "remotable object"? For example the API docs for IBinder state: This interface describes the abstract protocol for interacting with a remotable object. But I've searched and can't seem to…
Sound Conception
  • 5,263
  • 5
  • 30
  • 47
9
votes
1 answer

How to generate API Documentation using openapi-generator?

I'm new to the OpenAPI 3.0.0. I have successfully created a java client library using an openapi-generator. But OpenAPI Generator allows the generation of API client libraries (SDK generation), server stubs, documentation. So I want to know is…
Arun
  • 510
  • 2
  • 5
  • 9
9
votes
0 answers

RAML2HTML Templates Library

We recently decided to use RAML to document our API and all seems great so far. We are using the raml2html utility to generate static HTML documentation. The default template works great, but I've seen much better API pages. Does anyone know about…
Miroslav Nedyalkov
  • 1,101
  • 1
  • 10
  • 22
9
votes
2 answers

Spring Rest Doc not producing html

I followed the getting started guide for Spring Rest Doc word by word, but I cannot get any html out of the generated snippets. The snippets are generated fine in the directory I configure (build/generated-snippets), but I can't see any html5/…
Francesco
  • 857
  • 1
  • 11
  • 26
8
votes
3 answers

API documentation(Swagger UI ) for Python Azure function

We have built APIs based on Azure function and all of the APIs are python based. I know that APIM provides a nice way of importing Azure function and creating and managing APIs. However, i am looking for a light & quick solution for developers so…
SunilS
  • 2,030
  • 5
  • 34
  • 62
8
votes
2 answers

API Documentation tool for Rails 5

I have an API only rails app which needs documentation for frontend developers. And it's my first experience with it. What tool do you use for this purpose? Note that I am using rails 5 API and not Grape. I tested Apipie, swagger-blocks, and…
MalekMFS
  • 180
  • 2
  • 13
8
votes
1 answer

Where does Django REST Swagger generate a schema file?

I want to modify the Swagger documentation generated by Django REST Swagger. I'd like to find the API definition or schema file(s) that Django REST Swagger generates. I haven't been able to find those files. Is there something like a YAML or JSON…
pdesjardins
  • 106
  • 4
8
votes
1 answer

Need to create an api doc for an existing application written with nodejs/express

I have a few private apis written in plain old express. Time to let it out and provide some api documentation. What I don't want (at least yet) it to re-write my express app to integrate api documentation into the code. Mainly since I am not sure…
lostintranslation
  • 23,756
  • 50
  • 159
  • 262
1
2 3
…
11 12