| Package | Description |
|---|---|
| org.jsondoc.core.annotation | |
| org.jsondoc.core.pojo |
| Class and Description |
|---|
| ApiPathParam
This annotation is to be used inside an annotation of type ApiParams
|
| Class and 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.
|
| ApiAuthNone
This annotation is to be used on your "service" class, for example controllers, or on exposed methods.
|
| ApiFlow
This annotation is to be used on a method (typically on a class dedicated to
flow description) and contains an array of ApiFlowStep
|
| 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
|
| 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
|
| 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
|
Copyright © 2015. All rights reserved.