Stack Overflow
Stack Overflow

Questions tagged [jsondoc]

jsondoc is a java library to generate a documentation for annotated REST-Services.

Easily generate docs and playground for your RESTful API

http://jsondoc.org/

https://github.com/fabiomaffioletti/jsondoc

12 questions
8
votes
6 answers

I get a "Expected name at XX:YY" error on .json files in Eclipse. What is wrong?

I have this code in it now...with the entra line after the closing }... Here is a larger screenshot of it now! { "menu" : { "id": "file", "value": "File", "popup": { "menuitem": [ { "value" : "New", "onclick":…
beth
  • 425
  • 1
  • 8
  • 16
3
votes
0 answers

jsondoc-ui.html not loaded, error 404

I did not should be loaded jsondoc-ui.html, an error 404, although http://localhost:8080/jsondoc works and I get my documents, but without the user interface. Use your instructions http://jsondoc.org/how-to-spring-boot.html please help me…
proton
  • 31
  • 6
3
votes
1 answer

JSONDoc doesn't detect @ApiObject annotation of models in multimodule projects

With Spring Boot, JsonDoc nicely detects all the controllers but it doesn't detect models which are located in another maven module. Our project has 2 modules: my-app-core my-app-impl The main controllers as well as properties files e.g.…
xbmono
  • 2,084
  • 2
  • 30
  • 50
1
vote
0 answers

JSONDoc not showing up details about services

JSONDoc is implemented in the spring boot application, services' details are not shown up in the API lists. Screen shot is attached. The project is multimodule. The dependencies are in web module's pom which have controllers. …
ruveena
  • 1,248
  • 1
  • 10
  • 19
1
vote
1 answer

JSONDoc Flows Not Showing in Documentation

I am using JSONDoc for documentation on a REST API and for some reason the Flows only show the description and give an error The following errors prevent a correct functionality of the playground and do not provide enough documentation data for…
Michael Hatch
  • 45
  • 1
  • 7
1
vote
1 answer

JSONDoc Annotation on multidimensional objects

I am trying to put annotations from JSONDoc on multidimensional objects but with no success. Example: @ApiObjectField(description = "Multidimensional array with flags") private boolean[][] flags; The following exception is raised: GRAVE:…
rcorreia
  • 549
  • 1
  • 9
  • 27
0
votes
0 answers

How to show query list param in JSONDoc?

Is it possible to have a list of string as query param in JSONDoc ? My code works, but i can't test it on JSONDoc. My url is for example: /url?statut=A&statut=B Here is how the JSONDoc shows the test parameters : So i can't test with multiples…
anais1477
  • 466
  • 1
  • 17
  • 36
0
votes
2 answers

How to Print JSON Array

I tried but seems too many loops. Is there any optimal way? Input JSON: {"errors":[{"key":"XYZ","code":37373,"message":"Invalid XYZ Code"}]} Hard code key in the solution, not an issue. I have tried to print by below…
user2235747
  • 345
  • 6
  • 14
0
votes
0 answers

Spring Boot JsonDoc configuration, http://localhost:8080/jsondoc not getting document

I have a problem with configuration JsonDoc in my Spring Boot project. The jsondoc-ui.html is not detected. When i enter http://localhost:8080/jsondoc I am receiving blank object like: {"version":null, "basePath":null, "apis":{}, "objects":{}, …
wegtis
  • 303
  • 2
  • 4
  • 12
0
votes
0 answers

jsondoc AnnotationTypeMisMatchException when using @ApiMethod

I'm pretty sure that I'm missing something obvious here, but for some reason I keep getting the 'java.lang.annotation.AnnotationTypeMismatchException' error when I try to run the 'mvn jsondoc:generate -X' command. The full error is shown…
Marciano Viereck
  • 1
  • 1
0
votes
2 answers

How can i specify headers as application/json using JSONDOC

I am using Spring4 to design my REST API. But while I am documenting it using JsonDoc, it is giving me an error as: The server refused this request because the request entity is in a format not supported by the requested resource for the…
DEBENDRA DHINDA
  • 1,163
  • 5
  • 14
0
votes
2 answers

JSONDOC Creation showing exception

I want to document my REST Based API, so for that I searched the google and found this http://jsondoc.org/ I am using GuiceConfig to inject the objects and there I used the method JSONDocUtils.getApiDoc(servletContext, version, basePath); inside…
Ankur Verma
  • 5,793
  • 12
  • 57
  • 93