feign/core/src/main/java/feign/Body.java at master · OpenFeign/feign

45 lines (41 loc) · 1.49 KB

* 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 feign;

import static java.lang.annotation.ElementType.METHOD;

import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;

import java.lang.annotation.Target;

import java.util.Map;

/**

* A possibly templated body of a PUT or POST command. variables wrapped in curly braces are

* expanded before the request is submitted. <br>

* ex. <br>

* <pre>

* @Body("<v01:getResourceRecordsOfZone><zoneName>{zoneName}</zoneName><rrType>0</rrType></v01:getResourceRecordsOfZone>")

* List<Record> listByZone(@Param("zoneName") String zoneName);

* </pre>

* <br>

* Note that if you'd like curly braces literally in the body, urlencode them first.

* @see RequestTemplate#expand(String, Map)

@Target(METHOD)

@Retention(RUNTIME)

public @interface Body {

String value();

}

Provide feedback