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.dto.swagger.*;
018import org.apache.juneau.html.annotation.*;
019import org.apache.juneau.rest.*;
020import org.apache.juneau.rest.annotation.*;
021
022/**
023 * Sample REST resource that prints out a simple "Hello world!" message.
024 *
025 * <ul class='seealso'>
026 *    <li class='extlink'>{@source}
027 * </ul>
028 */
029@RestResource(
030   title="Hello World",
031   description="An example of the simplest-possible resource",
032   path="/helloWorld"
033)
034@HtmlDocConfig(
035   aside={
036      "<div style='max-width:400px' class='text'>",
037      "  <p>This page shows a resource that simply response with a 'Hello world!' message</p>",
038      "  <p>The POJO serialized is a simple String.</p>",
039      "</div>"
040   }
041)
042public class HelloWorldResource implements BasicRestConfig {
043
044   /**
045    * GET request handler.
046    *
047    * @return A simple Hello-World message.
048    */
049   @RestMethod(name=GET, path="/*", summary="Responds with \"Hello world!\"")
050   public String sayHello() {
051      return "Hello world!";
052   }
053
054   @Override
055   public Swagger getOptions(RestRequest req) {
056      return req.getSwagger();
057   }
058}