- AbstractDoc - Class in org.jsondoc.core.pojo
-
- AbstractDoc() - Constructor for class org.jsondoc.core.pojo.AbstractDoc
-
- AbstractJSONDocScanner - Class in org.jsondoc.core.scanner
-
- AbstractJSONDocScanner() - Constructor for class org.jsondoc.core.scanner.AbstractJSONDocScanner
-
- addItemToType(String) - Method in class org.jsondoc.core.util.JSONDocType
-
- addJsondocerror(String) - Method in class org.jsondoc.core.pojo.AbstractDoc
-
- addJsondochint(String) - Method in class org.jsondoc.core.pojo.AbstractDoc
-
- addJsondocwarning(String) - Method in class org.jsondoc.core.pojo.AbstractDoc
-
- addMethod(ApiMethodDoc) - Method in class org.jsondoc.core.pojo.ApiDoc
-
- addMethod(ApiMethodDoc) - Method in class org.jsondoc.core.pojo.ApiFlowDoc
-
- addPrecondition(String) - Method in class org.jsondoc.core.pojo.ApiFlowDoc
-
- addStep(ApiFlowStepDoc) - Method in class org.jsondoc.core.pojo.ApiFlowDoc
-
- addTestUser(String, String) - Method in class org.jsondoc.core.pojo.ApiAuthDoc
-
- allApiMethodDocs - Variable in class org.jsondoc.core.scanner.AbstractJSONDocScanner
-
- ANONYMOUS - Static variable in class org.jsondoc.core.scanner.DefaultJSONDocScanner
-
- Api - Annotation Type in org.jsondoc.core.annotation
-
This annotation is to be used on your "service" class, for example controller classes in Spring MVC.
- ApiAuthBasic - Annotation Type in org.jsondoc.core.annotation
-
This annotation is to be used on your "service" class, for example controllers, or on exposed methods.
- ApiAuthBasicUser - Annotation Type in org.jsondoc.core.annotation
-
This annotation is to be used inside an annotation of type ApiAuthBasic.
- ApiAuthDoc - Class in org.jsondoc.core.pojo
-
- ApiAuthDoc() - Constructor for class org.jsondoc.core.pojo.ApiAuthDoc
-
- ApiAuthNone - Annotation Type in org.jsondoc.core.annotation
-
This annotation is to be used on your "service" class, for example controllers, or on exposed methods.
- ApiAuthType - Enum in org.jsondoc.core.pojo
-
- ApiBodyObject - Annotation Type in org.jsondoc.core.annotation
-
This annotation is to be used on your method and represents the body object
passed the request.
- ApiBodyObjectDoc - Class in org.jsondoc.core.pojo
-
- ApiBodyObjectDoc(JSONDocType) - Constructor for class org.jsondoc.core.pojo.ApiBodyObjectDoc
-
- ApiDoc - Class in org.jsondoc.core.pojo
-
- ApiDoc() - Constructor for class org.jsondoc.core.pojo.ApiDoc
-
- ApiError - Annotation Type in org.jsondoc.core.annotation
-
This annotation is to be used inside an annotation of type ApiErrors
- ApiErrorDoc - Class in org.jsondoc.core.pojo
-
- ApiErrorDoc(String, String) - Constructor for class org.jsondoc.core.pojo.ApiErrorDoc
-
- ApiErrors - Annotation Type in org.jsondoc.core.annotation
-
This annotation is to be used on your method and represents the possible errors returned by the method
- ApiFlow - Annotation Type in org.jsondoc.core.annotation
-
This annotation is to be used on a method (typically on a class dedicated to
flow description) and contains an array of ApiFlowStep
- ApiFlowDoc - Class in org.jsondoc.core.pojo
-
- ApiFlowDoc() - Constructor for class org.jsondoc.core.pojo.ApiFlowDoc
-
- ApiFlowSet - Annotation Type in org.jsondoc.core.annotation
-
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 - Annotation Type in org.jsondoc.core.annotation
-
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
- ApiFlowStepDoc - Class in org.jsondoc.core.pojo
-
- ApiFlowStepDoc() - Constructor for class org.jsondoc.core.pojo.ApiFlowStepDoc
-
- ApiHeader - Annotation Type in org.jsondoc.core.annotation
-
This annotation is to be used inside an annotation of type ApiHeaders
- ApiHeaderDoc - Class in org.jsondoc.core.pojo
-
- ApiHeaderDoc(String, String, String[]) - Constructor for class org.jsondoc.core.pojo.ApiHeaderDoc
-
- ApiHeaders - Annotation Type in org.jsondoc.core.annotation
-
This annotation is to be used on your method and contains an array of ApiHeader
- ApiMethod - Annotation Type in org.jsondoc.core.annotation
-
This annotation is to be used on your exposed methods.
- ApiMethodDoc - Class in org.jsondoc.core.pojo
-
- ApiMethodDoc() - Constructor for class org.jsondoc.core.pojo.ApiMethodDoc
-
- ApiObject - Annotation Type in org.jsondoc.core.annotation
-
This annotation is to be used on your object classes and represents an object used for communication between clients and server
- ApiObjectDoc - Class in org.jsondoc.core.pojo
-
- ApiObjectDoc() - Constructor for class org.jsondoc.core.pojo.ApiObjectDoc
-
- ApiObjectField - Annotation Type in org.jsondoc.core.annotation
-
This annotation is to be used on your objects' fields and represents a field of an object
- ApiObjectFieldDoc - Class in org.jsondoc.core.pojo
-
- ApiObjectFieldDoc() - Constructor for class org.jsondoc.core.pojo.ApiObjectFieldDoc
-
- ApiParamDoc - Class in org.jsondoc.core.pojo
-
- ApiParamDoc(String, String, JSONDocType, String, String[], String, String) - Constructor for class org.jsondoc.core.pojo.ApiParamDoc
-
- ApiParams - Annotation Type in org.jsondoc.core.annotation
-
This annotation is to be used on your method and contains an array of ApiParam
- ApiParamType - Enum in org.jsondoc.core.pojo
-
- ApiPathParam - Annotation Type in org.jsondoc.core.annotation
-
This annotation is to be used inside an annotation of type ApiParams
- ApiQueryParam - Annotation Type in org.jsondoc.core.annotation
-
This annotation is to be used inside an annotation of type ApiParams
- ApiResponseObject - Annotation Type in org.jsondoc.core.annotation
-
This annotation is to be used on your method and represents the returned value
- ApiResponseObjectDoc - Class in org.jsondoc.core.pojo
-
- ApiResponseObjectDoc(JSONDocType) - Constructor for class org.jsondoc.core.pojo.ApiResponseObjectDoc
-
- ApiVerb - Enum in org.jsondoc.core.pojo
-
- ApiVersion - Annotation Type in org.jsondoc.core.annotation
-
This annotation is to be used on your "service" class, for example controller classes in Spring MVC.
- ApiVersionDoc - Class in org.jsondoc.core.pojo
-
- ApiVersionDoc() - Constructor for class org.jsondoc.core.pojo.ApiVersionDoc
-