RestApiMountPoint.java

/*
 * Copyright 2011 TaskDock, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.versly.rest.wsdoc;

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

/**
 * <p>Documents the expected REST URL path to which the {@link org.springframework.web.bind.annotation.RequestMapping}s
 * in this class will be mounted, presumably by a servlet configuration etc. This should not include the hostname.</p>
 * <br/>
 * <p>For example: <code>@RestApiMountPoint("/api/v1/users/")</code>.</p>
 */
@Target(ElementType.TYPE)
public @interface RestApiMountPoint {
    String value();
}