MultiApiLevelDocs.java

import org.versly.rest.wsdoc.DocumentationScope;
import org.versly.rest.wsdoc.DocumentationRestApi;

import javax.ws.rs.GET;
import javax.ws.rs.Path;

public class MultiApiLevelDocs {

    /**
     * This is the header documentation text for RestApi1.
     */
    @DocumentationRestApi(id = "RestApi1", title = "The RestApi1 API", version = "v1", mount = "/restapi1/api/v1")
    @DocumentationScope("public")
    public class RestApi1 {

        /**
         * Returns the contents of the widgets collecion.
         *
         * @param id The widget identifier.
         */
        @GET
        @Path("/widgets")
        public void getWidgets() {
        }
    }


    /**
     * This is the header documentation text for RestApi2.  This API actually spans
     * multiple controller classes, RestApi2_A and RestApi2_B.  This former declares
     * the title, version, and provides API level documentation, the latter just
     * indicates it has the same identifier as the former and it's resources will
     * be merged in.
     */
    @DocumentationRestApi(id = "RestApi2", title = "The RestApi2 API", version = "v1", mount = "/restapi2/api/v1")
    @DocumentationScope("public")
    public class RestApi2_A {

        /**
         * Returns the contents of the gadgets collecion.
         *
         * @param id The gadget identifier.
         */
        @GET
        @Path("/gadgets")
        public void getGadgets() {
        }
    }


    @DocumentationRestApi(id = "RestApi2", mount = "/restapi2/api/v1")
    @DocumentationScope("public")

    public class RestApi2_B {

        /**
         * Some description of the whirlygigs.
         *
         * @param id The whirlygig identifier.
         */
        @GET
        @Path("/whirlygigs")
        public void getWhirlygigs() {
        }
    }
}