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
1
vote
1 answer

Disabling syntax error highlighting in Slate

Is there a way to disable error highlighting when there are some extra elements in JSON snippets. My use case is that I want to include comments into JSON to make it more understandable. I know that it's not a part of language specification, but…
Vyacheslav
  • 1,186
  • 2
  • 15
  • 29
1
vote
1 answer

rails api dock syntax

ROR Api Dock always starts with a syntax of the method. My example will be link_to: link_to(name = nil, options = nil, html_options = nil, &block) public My question is on the "name=nil" or "something = nil" which i see on most every command. A…
eaglerockdude
  • 11
  • 3
1
vote
0 answers

Apidoc for Flask-JWT's authentication url

I have started using apidoc for generating REST api documentation. I have tried different things with it. In my flask based api application, I use JWT (flask-jwt in particular) for authentication. The doc gets generated properly, but the request…
Hussain
  • 5,057
  • 6
  • 45
  • 71
1
vote
1 answer

Document Spring OAuth 2.0 APIs using Swagger

I am working on setting up an OAuth 2.0 authorization server using Spring security. I would like to document the OAuth 2.0 APIs using Swagger. How should I go about doing it?
sunsin1985
  • 2,437
  • 5
  • 22
  • 27
1
vote
1 answer

Apidocjs throws warnings when i attempt to update

Ok, so I'm playing around with apidocjs to figure it out before implementing it in a production environment and am incountering the following: ~/apidoc_playground$ apidoc warn: parser plugin 'param' not found in block: 0 info: Done. the following…
Arly Mathiasen
  • 29
  • 6
1
vote
2 answers

How to make Nelmio ApiDoc annotations pass request method to my forms?

I use dynamic forms (defined as services(!)) to enable/disable some fields for specific request (POST/PUT/PATCH). I want that to be displayed in ApiDoc automatically by passing options to form as described in documentation. But it doesn't work. I…
Yuriy Nazarenko
  • 83
  • 1
  • 1
  • 8
1
vote
0 answers

swagger api model is displaying wrapper classes

we are using swagger for documentation. We have mentioned @ApiModel on Pojo, problem here is if you have any wrapper classes like Integer, BigDecimal etc it is documenting those classes as well. Here is the Pojo, @XmlRootElement @ApiModel public…
Sunil Rk
  • 999
  • 6
  • 12
  • 35
1
vote
1 answer

NLTK 3 release 4 API documentation

Hi all just a quick question. I am working with nltk Version 3 Release 4 (Python 3). I can only find API docs for version 3.0 and it seems that there has been some depreciation between releases. For example API docs (for 3.0) state that …
Joe
  • 1,455
  • 2
  • 19
  • 36
1
vote
6 answers

Apidocjs document creation issue, warning : plugin param parser not found and missing comma issue

I tried to create API documentation using apidocjs and i got issues while compiling project for creating apidoc using apidoc.json on project folder. Code here : ~$ apidoc -i ./ -o apidoc/ And result warning: parser plugin 'param' not found. error: …
Prasanth P
  • 715
  • 2
  • 9
  • 24
1
vote
1 answer

Where can I find / modify Loopbackjs model metadata?

As you might now, Loopbackjs framework displays a swagger-based explorer interface exposing your API endpoints and briefly explaining the methods. The problem it's that this interface it a little too much interactive. I need to provide an api-docs…
ffflabs
  • 17,166
  • 5
  • 51
  • 77
1
vote
1 answer

ApiDoc error: parser plugin "apimethod" not found

I have written an RESTful API with Slim Framework. For documentation I want to user APIDoc. I installed apidoc via npm (did not work without sudo) $ sudo npm install apidoc -g I inserted this example annotation in one project file…
sgotre
  • 405
  • 3
  • 18
1
vote
0 answers

node library to construct demo pages to exhaustively test out API

Given an API I can imagine a javascript library (serverside in Node) may exist that can construct demo-pages to test out these API-methods exhaustively. Something like: https://developers.google.com/apis-explorer Anyone knows of a library like…
Geert-Jan
  • 18,623
  • 16
  • 75
  • 137
0
votes
0 answers

How to render a hashmap with OpenAPI 3.1 and Nelmio?

I would like to correctly render a hashmap (key: a UUID, value: an object) both in the Response schema AND the Response samples (examples) sections of my API doc such: { "objects": { "3a34655e-9566-4d5e-bce7-8fa71670993b": { "title":…
Bouss
  • 3
  • 4
0
votes
0 answers

How to enable PKCE flow in Swagger YML

We use Swagger YML for the API documentation. In swagger YML we can specify the authentication flow in the securitySchemes Is there any way that we can enable authorizationCode flow with PKCE in the yml. I know this can be possible with swagger…
Surajit Kundu
  • 455
  • 1
  • 7
  • 17
0
votes
0 answers

Generating Schema in API documentation with redocly

I am using redocly for generating API documentation. Currently redocly generates API documentation for endpoints (paths), but does not generate schema documentation. This blog on their website explains how to generate the schema section by…
Amrish
  • 679
  • 1
  • 8
  • 20
1 2 3
…
11 12