Package org.jsondoc.core.annotation

Annotation Types Summary

Annotation Type	Description
Api	This annotation is to be used on your "service" class, for example controller classes in Spring MVC.
ApiAuthBasic	This annotation is to be used on your "service" class, for example controllers, or on exposed methods.
ApiAuthBasicUser	This annotation is to be used inside an annotation of type ApiAuthBasic.
ApiAuthNone	This annotation is to be used on your "service" class, for example controllers, or on exposed methods.
ApiBodyObject	This annotation is to be used on your method and represents the body object passed the request.
ApiError	This annotation is to be used inside an annotation of type ApiErrors
ApiErrors	This annotation is to be used on your method and represents the possible errors returned by the method
ApiFlow	This annotation is to be used on a method (typically on a class dedicated to flow description) and contains an array of ApiFlowStep
ApiFlowSet	This annotation is to be used on a type (typically on a class dedicated to flow description) and will trigger scanning for @ApiFlow annotations
ApiFlowStep	This annotation is to be used inside an annotaion of type @ApiFlow and references a method previously documented with the JSONDoc @ApiMethod annotation in which the "id" property is specified
ApiHeader	This annotation is to be used inside an annotation of type ApiHeaders
ApiHeaders	This annotation is to be used on your method and contains an array of ApiHeader
ApiMethod	This annotation is to be used on your exposed methods.
ApiObject	This annotation is to be used on your object classes and represents an object used for communication between clients and server
ApiObjectField	This annotation is to be used on your objects' fields and represents a field of an object
ApiParams	This annotation is to be used on your method and contains an array of ApiParam
ApiPathParam	This annotation is to be used inside an annotation of type ApiParams
ApiQueryParam	This annotation is to be used inside an annotation of type ApiParams
ApiResponseObject	This annotation is to be used on your method and represents the returned value
ApiVersion	This annotation is to be used on your "service" class, for example controller classes in Spring MVC.