001/*
002 * Copyright 2002-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.web.bind.annotation;
018
019import java.lang.annotation.Documented;
020import java.lang.annotation.ElementType;
021import java.lang.annotation.Retention;
022import java.lang.annotation.RetentionPolicy;
023import java.lang.annotation.Target;
024
025import org.springframework.stereotype.Controller;
026
027/**
028 * A convenience annotation that is itself annotated with
029 * {@link Controller @Controller} and {@link ResponseBody @ResponseBody}.
030 * <p>
031 * Types that carry this annotation are treated as controllers where
032 * {@link RequestMapping @RequestMapping} methods assume
033 * {@link ResponseBody @ResponseBody} semantics by default.
034 *
035 * <p><b>NOTE:</b> {@code @RestController} is processed if an appropriate
036 * {@code HandlerMapping}-{@code HandlerAdapter} pair is configured such as the
037 * {@code RequestMappingHandlerMapping}-{@code RequestMappingHandlerAdapter}
038 * pair which are the default in the MVC Java config and the MVC namespace.
039 * In particular {@code @RestController} is not supported with the
040 * {@code DefaultAnnotationHandlerMapping}-{@code AnnotationMethodHandlerAdapter}
041 * pair both of which are also deprecated.
042 *
043 * @author Rossen Stoyanchev
044 * @author Sam Brannen
045 * @since 4.0
046 */
047@Target(ElementType.TYPE)
048@Retention(RetentionPolicy.RUNTIME)
049@Documented
050@Controller
051@ResponseBody
052public @interface RestController {
053
054        /**
055         * The value may indicate a suggestion for a logical component name,
056         * to be turned into a Spring bean in case of an autodetected component.
057         * @return the suggested component name, if any (or empty String otherwise)
058         * @since 4.0.1
059         */
060        String value() default "";
061
062}