com.apporiented.rest.apidoc.annotation

Annotation Type ApiDoc

@Documented
 @Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface ApiDoc

This annotations is to be used on your "service" class, for example controller classes in Spring MVC.

Author:

Fabio Maffioletti, Lars Behnke

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	description
String	name

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>[]	errorResponseClasses

Element Detail

description

public abstract String description

name

public abstract String name

errorResponseClasses

public abstract Class<?>[] errorResponseClasses

Default:

{}