• Home
• com.wordnik
• swagger-annotations_2.10.0-RC3
• 1.2.0
• source code
• ApiClass.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.wordnik.swagger.annotations.ApiClass Maven / Gradle / Ivy

package com.wordnik.swagger.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * A bean class used in the REST-api.
 * Suppose you have an interface
 * @PUT @ApiOperation(...) void foo(FooBean fooBean), there is
 * no direct way to see what fields FooBean would have. This
 * annotation is meant to give a description of FooBean and
 * then have the fields of it be annotated with
 * @ApiProperty.
 *
 * @author Heiko W. Rupp
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ApiClass {

    /** Provide a synopsis of this class */
    String value() default "";
    /** Provide a longer description of the class */
    String description() default "";
}