Annotation Type Url


Uses the annotated String parameter as the method's entire URL, instead of resolving one from the HTTP method annotation's template (with @BaseUrl/a runtime base URL and @PathParams). For a call whose URL isn't a fixed shape known in advance - a pagination next link, a HATEOAS action link from a previous response - where the caller already holds the full URL to call verbatim:
 @GET
 Page<Item> nextPage(@Url String url);
 
Only valid alongside a method whose HTTP method annotation has no value() of its own - combining a static URL template with @Url fails validation, since there would be two conflicting sources of truth for the URL. At most one parameter per method may be annotated @Url. @PathParam/@BaseUrl/a runtime base URL are all ignored when @Url is used - there's no template left for them to apply to - but @QueryParam/@HeaderParam/etc. still work normally, appended to the given URL.