com.spotify.docgenerator.test.EndpointLookingThing Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of testproject Show documentation

The newest version!

/*
 * Copyright (c) 2014 Spotify AB.
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 com.spotify.docgenerator.test;

import com.google.common.collect.ImmutableList;

import javax.ws.rs.DefaultValue;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;

import static javax.ws.rs.core.MediaType.APPLICATION_JSON;

/**
 * Yay, some javadoc that might be helpful
 *
 * @author drewc
 */
@Path("/jobs")
public class EndpointLookingThing {
  /**
   * Javadoc for your happy little method
   *
   * @param q
   * @return
   */
  @Path("/get")
  @GET
  @Produces(APPLICATION_JSON)
  public SimpleSerializedThing list(@QueryParam("q") @DefaultValue("") final String q) {
    return new SimpleSerializedThing("WHEE", ImmutableList.of("DOH"));
  }
}