Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

interface-annotations-doc #971

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions docs/modules/ROOT/pages/spring-cloud-openfeign.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -949,6 +949,36 @@ TIP: If you want to run Spring Cloud OpenFeign clients in AOT or native image mo

TIP: However, if you set the `url` value via properties, it is possible to override the `@FeignClient` `url` value by running the image with `-Dspring.cloud.openfeign.client.config.[clientId].url=[url]` flag. In order to enable overriding, a `url` value also has to be set via properties and not `@FeignClient` attribute during buildtime.

[[interface-annotations]]
== Interface Annotations

For those who are familiar with Spring Web annotations, the following table describes the main differences between the Spring annotations and their Feign counterparts:

|===
|HTTP Protocol |Spring Web |Feign

|Request line
|`@RequestMapping` ...
|`@RequestLine`

|Path
|`@PathVariable`, `@MatrixVariable`
|`@Param`

|Query
|`@SpringQueryMap`,`@RequestParam`
|`@QueryMap`, `@Param`

|Request Headers
|`@RequestHeader`
|`@Headers`, `@HeaderMap`

|Request Body
|`@RequestBody`
|`@Body`

|===

[[configuration-properties]]
== Configuration properties

Expand Down