org.jsondoc.core.annotation

Annotation Type ApiBodyObject

@Documented
@Target(value={PARAMETER,METHOD})
@Retention(value=RUNTIME)
public @interface ApiBodyObject

This annotation is to be used on your method and represents the body object passed the request.

Author:

Fabio Maffioletti

See Also:

ApiObject

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>	clazz Specify this element if you need to use the ApiBodyObject annotation on the method declaration and not inside the method's signature.

Element Detail

clazz

public abstract Class<?> clazz

Specify this element if you need to use the ApiBodyObject annotation on the method declaration and not inside the method's signature. This is to be able to document old style servlets' methods like doGet and doPost. This element, even if specified, is not taken into account when the annotation is put inside the method's signature.

Returns:

Default:

org.jsondoc.core.util.JSONDocDefaultType.class