If your api has the same behavior across the whole application, you can inform your api users using the ApiGlobal annotation. Let's see how with an example:
To correctly let JSONDoc find the static files, they need to be on the classpath. For example, put them in the src/main/resources directory, and specify the relative path to that directory, like /jsondoc/filename.html. To make this work properly, these files must be prefixed with /jsondocfile:.
Annotation to document changelogs
It's useful to document changes occurred in the new version of your api. This can be done easily with this annotation:
Annotation to document migrations
It's useful to document steps that must be made by api users to migrate from one version to another one. This can be done easily with this annotation: