com.ifengxue.http.annotation.QueryParam Maven / Gradle / Ivy

/*
 * Copyright 2019 https://www.ifengxue.com
 *
 * 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 com.ifengxue.http.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 查询参数

 *  *  @Rest("https://httpbin.org")
 *  interface Httpbin {
 *    @Post("/post")
 *    JSONObject post(@QueryParam(name = "foo") String foo, @Param(name = "bar") String bar);
 *  }
 *  则最终访问的URL是: https://httpbin.org/post?foo=value
 *  请求的body是: {"foo":"value","bar":"value"}
 * 
 */
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface QueryParam {

  /**
   * 参数名称
   */
  String name();
}