JSONDoc

easily generate docs and playground for your RESTful API

Contacts

Email StackOverflow

• Home
• Getting started
• Migrate from previous versions

---

• How to: standalone
• How to: with Spring MVC
• How to: with Spring Boot
• How to: with Maven plugin
• How to: package docs bundle

---

• Annotations
• Configuration

---

• Examples: standalone
• Examples: Spring framework
• Examples: objects
• Examples: flows
• Examples: global
• Demo

---

• Downloads
• Changelog
• FAQ
• Credits

Version 1.2.23 Jan 5, 2021

• Bump hibernate-validator from 5.3.5.Final to 5.3.6.Final in /jsondoc-core
• Bump jackson-databind from 2.9.9.2 to 2.9.10.5
• Fix flaky test JSONDocApiAuthBuilderTest#testApiAuthToken
• Bump junit from 4.11 to 4.13.1
• Fixes #253: Use Spring 3 compatible param builder.
• fixes #250 set required for NotNull, NotEmpty, NotBlank validations

Version 1.2.22 Aug 3, 2019

• Jackson vulnerability resolution

Version 1.2.21 Jul 6, 2019

• Jackson vulnerability resolution

Version 1.2.20 Mar 20, 2019

• Update version of org.reflections:reflections

Version 1.2.19 Dec 20, 2017

• Not support Spring 4.3 @Get/@PostMapping etc

Version 1.2.18 Nov 22, 2017

• Improve support of spring mvc request mapping
• Duplicated Summary when multiple values at @requestMapping
• Ignore static fields in SpringObjectBuilder
• RequestParam#name() ignored
• @RequestParam(name = "param_name") ignored
• Java 8 compatibility
• Class constants shouldn't be display in playground
• Feature request, support for multi request mapping

Version 1.2.17 Feb 22, 2017

• Removed jLinq library

Version 1.2.16 Aug 5, 2016

• TypeVariableImpl cannot be cast to java.lang.reflect.ParameterizedType

Version 1.2.15 May 10, 2016

• Hotfixes

Version 1.2.14 May 4, 2016

• Add support for RepositoryRestController
• Spring 3 Support

Version 1.2.13 Apr 14, 2016

• ApiGlobalSection don't keep order given in annotation ApiGlobal
• Generate description based on method name
• Spring RequestMapping "path" variable is ignored

Version 1.2.11 Jan 19, 2016

• Make the scanner traverse more than one level deep

Version 1.2.10 Nov 29, 2015

• fixed regression on issue #146

Version 1.2.9 Oct 3, 2015

• Minor fixes

Version 1.2.8 Oct 2, 2015

• @ApiObject ignored for ParameterizedType return objects

Version 1.2.7 Oct 2, 2015

• Allow ApiAuthToken (was Allow insert custom header value from playground form)

Version 1.2.6 Oct 1, 2015

• Create Object Field Requirements from Hibernate Validation Annotations

Version 1.2.5 Sep 24, 2015

• Avoid using JSONDoc annotation on objects in Spring's applications
• ClassCastException: sun.reflect.generics.reflectiveObjects.TypeVariableImpl cannot be cast to java.lang.reflect.ParameterizedType
• Demo Application - /cities POST gives 415 (Unsupported Media Type)
• Default value for Spring MVC consumes

Version 1.2.4 Sep 2, 2015

• Global documentation
• Default value for Spring MVC produces

Version 1.2.2 Aug 26, 2015

• Fix NPE during startup when Sprint.getVersion() returns null

Version 1.2.1 Aug 25, 2015

• Jsondoc offline placeholder verification

Version 1.2.0 Aug 17, 2015

• visibility and stage properties on Api, ApiMethod and ApiObject
• Spring auto JSONDoc scanner
• Can jsondoc understand spring annotation, like @RequestBody and @PathVariable?
• Support array of path in @ApiMethod
• Documentation url in jsondoc-ui.html parameters
• API status annotation

Version 1.1.16 Aug 4, 2015

• Support array of verb in @ApiMethod
• allowedvalues ignored for APIObjectField if it's an enum type
• UI : Some questions.
• Separate css and js from html in UI projects
• ApiHeaders should be allowed at class level

Version 1.1.15 Jun 11, 2015

• Ordering of @ApiObjectField

Version 1.1.14 May 19, 2015

• Multiple methods with different params are not displayed
• ApiQueryParam should use @RequestParam value attribute for its name by default

Version 1.1.13 Mar 17, 2015

• Add possibility to insert HTML in descriptions
• Possibility to hide playground
• Possibility to switch between URI centric and Summary centric display

Version 1.1.12 Feb 23, 2015

• Templates field names are not overridden
• Remove query parameters on api method path
• Query param allowedvalues
• APIObjectField not using ApiObject name for collections

Version 1.1.11 Feb 06, 2015

• Relaxed check on ApiHeader name and description
• Management of Spring MVC @RequestHeader annotation
• Improvement on the UI

Version 1.1.9 Feb 03, 2015

• Removed dependency to jackson from jsondoc-springmvc module
• Added javadoc on starter configuration properties

Version 1.1.7 Jan 27, 2015

• Start consolidation of UI and UI webjar
• New "How to" regarding how to bundle a distributable documentation

Version 1.1.6 Jan 24, 2015

• NPE in ApiResponseObjectDoc

Version 1.1.5 Jan 25, 2015

• NPE in ApiObjectDoc
• playground Validation errors: id must not be empty

Version 1.1.4 Jan 23, 2015

• Offline generation for Spring based projects
• SLF4J for logging facade
• Unable to override default responsestatus of 200

Version 1.1.3 Jan 21, 2015

• Add allowedvalues to ApiHeader
• Management of params on RequestParam Spring annotation
• NPE when using maven plugin to generate api for interface
• Added new sample for Spring Boot

Version 1.1.2 Jan 19, 2015

• Possibility to document API Flows

Version 1.1.1 Jan 18, 2015

• Add option "template" in ApiBodyObject
• Required fields are not checked in playground
• JSONDoc cannot run with Java 6

Version 1.1.0 Jan 12, 2015

• Support custom API response status
• Spring Annotation Support
• Relax check on name for ApiObject
• Relax check on description for ApiObjectField
• Autoselect Content-Type to first value in playground
• Handle ResponseEntity in jsondoc type builder
• Add default value to ApiParamDoc to map "default value" of spring mvc RequestParam
• Produces and consumes must become Sets
• Relax check on path and description on ApiMethod
• ApiVerb default to GET
• Manage relaxed checks on ApiMethod path and description on ui
• Add jsondocerrors/warnings/hints on ApiParamDoc, ApiMethodDoc, ApiObjectDoc
• Use spring mvc module in spring boot starter
• Split ApiParam into ApiPathParam and ApiQueryParam
• Relax check on description on ApiParamDoc
• Support all rest verbs

Version 1.0.9 Jan 2, 2015

• LinkedHashSet in ApiParamDoc.getApiParamDocs()
• Removed servlet-api dependency as it's not needed for build
• Support Patch request
• spring-boot-starter-jsondoc
• jsondoc-ui-webjar

Version 1.0.6 Dec 5, 2014

• Class override in ApiBodyObject
• Create example for Spark
• Api param at method level
• Upgrade UI libraries
• Class override in ApiResponseObject
• Groups for apis and objects
• POST with Content-Type application/json doesn't work in playground
• Added jsondoc-maven-plugin
• Multiple API methods with the same path

Version 1.0.5 Nov 23, 2014

• ApiObjectFieldDoc fails on Maps that contain either a key or value that is a ParameterizedType
• Refactoring of generic types checks
• Upgrade to org.reflections 0.9.9
• Fixed issues with ApiObjectField annotations complex generic types

Version 1.0.4 Sep 25, 2014

• Support API versioning
• Manage Basic Authenticated methods
• Show enum values
• Allowed values now displayed on @ApiObjectField
• Parameters of Long[] or long[] throw exceptions
• Missing format for object field in jsondoc-ui
• Custom @ApiObjectField name
• Enable Travis CI builds

Version 1.0.3 Sep 17, 2014

• JSONDoc released on Maven Central repository

Version 1.0.2 Jan 11, 2014

• Removed the need of a servlet context by letting the user specify which packages to scan
• Some bug fixing in jsondoc-ui and jsondoc-core
• Wilcard type checks in ApiDocObjects generation

Version 1.0.1 May 12, 2013

• Fixed bug in jsondoc-ui

Version 1.0.0 May 8, 2013

• Initial release

---

Version 1.2.23 | Licensed under MIT License

GitHub Project | Issues