001// ***************************************************************************************************************************
002// * Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.  See the NOTICE file *
003// * distributed with this work for additional information regarding copyright ownership.  The ASF licenses this file        *
004// * to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance            *
005// * with the License.  You may obtain a copy of the License at                                                              *
006// *                                                                                                                         *
007// *  http://www.apache.org/licenses/LICENSE-2.0                                                                             *
008// *                                                                                                                         *
009// * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an  *
010// * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the        *
011// * specific language governing permissions and limitations under the License.                                              *
012// ***************************************************************************************************************************
013package org.apache.juneau.examples.rest;
014
015import static org.apache.juneau.http.HttpMethodName.*;
016
017import org.apache.juneau.rest.*;
018import org.apache.juneau.rest.annotation.*;
019
020/**
021 * Sample REST resource that prints out a simple "Hello world!" message.
022 */
023@RestResource(
024   title="Hello World",
025   description="An example of the simplest-possible resource",
026   path="/helloWorld",
027   htmldoc=@HtmlDoc(
028      aside={
029         "<div style='max-width:400px' class='text'>",
030         "  <p>This page shows a resource that simply response with a 'Hello world!' message</p>",
031         "  <p>The POJO serialized is a simple String.</p>",
032         "</div>"
033      }
034   )
035)
036public class HelloWorldResource implements BasicRestConfig {
037
038   /** GET request handler */
039   @RestMethod(name=GET, path="/*", summary="Responds with \"Hello world!\"")
040   public String sayHello() {
041      return "Hello world!";
042   }
043}