JAX-RS расшифровывается как JAVA API для RESTful Web Services. JAX-RS — это API-интерфейс и спецификация языка программирования на основе JAVA, обеспечивающие поддержку созданных веб-служб RESTful. Его версия 2.0 была выпущена 24 мая 2013 года. JAX-RS использует аннотации, доступные в Java SE 5, чтобы упростить разработку создания и развертывания веб-сервисов на основе JAVA. Он также поддерживает создание клиентов для веб-служб RESTful.
Характеристики
Ниже приведены наиболее часто используемые аннотации для сопоставления ресурса как ресурса веб-службы.
| Sr.No. | Аннотация и описание |
|---|---|
|
1 |
@Дорожка Относительный путь класса / метода ресурса. |
|
2 |
@ПОЛУЧИТЬ HTTP Get request, используется для получения ресурса. |
|
3 |
@ПОЛОЖИЛ HTTP PUT-запрос, используемый для создания ресурса. |
|
4 |
@СООБЩЕНИЕ HTTP POST-запрос, используемый для создания / обновления ресурса. |
|
5 |
@УДАЛЯТЬ HTTP-запрос DELETE, используемый для удаления ресурса. |
|
6 |
@ГОЛОВА HTTP HEAD запрос, используется для получения статуса доступности метода. |
|
7 |
@Produces Устанавливает HTTP-ответ, сгенерированный веб-службой. Например, APPLICATION / XML, TEXT / HTML, APPLICATION / JSON и т. Д. |
|
8 |
@Consumes Устанавливает тип HTTP-запроса. Например, application / x-www-formurlen закодирован для принятия данных формы в теле HTTP во время запроса POST. |
|
9 |
@PathParam Связывает параметр, переданный методу, со значением в пути. |
|
10 |
@QueryParam Связывает параметр, переданный методу, с параметром запроса в пути. |
|
11 |
@MatrixParam Связывает параметр, переданный методу, с параметром матрицы HTTP в пути. |
|
12 |
@HeaderParam Связывает параметр, переданный методу, с заголовком HTTP. |
|
13 |
@CookieParam Связывает параметр, переданный методу, с файлом cookie. |
|
14 |
@FormParam Связывает параметр, переданный методу, со значением формы. |
|
15 |
@Значение по умолчанию Назначает значение по умолчанию для параметра, передаваемого методу. |
|
16 |
@Context Контекст ресурса. Например, HTTPRequest в качестве контекста. |
1
@Дорожка
Относительный путь класса / метода ресурса.
2
@ПОЛУЧИТЬ
HTTP Get request, используется для получения ресурса.
3
@ПОЛОЖИЛ
HTTP PUT-запрос, используемый для создания ресурса.
4
@СООБЩЕНИЕ
HTTP POST-запрос, используемый для создания / обновления ресурса.
5
@УДАЛЯТЬ
HTTP-запрос DELETE, используемый для удаления ресурса.
6
@ГОЛОВА
HTTP HEAD запрос, используется для получения статуса доступности метода.
7
@Produces
Устанавливает HTTP-ответ, сгенерированный веб-службой. Например, APPLICATION / XML, TEXT / HTML, APPLICATION / JSON и т. Д.
8
@Consumes
Устанавливает тип HTTP-запроса. Например, application / x-www-formurlen закодирован для принятия данных формы в теле HTTP во время запроса POST.
9
@PathParam
Связывает параметр, переданный методу, со значением в пути.
10
@QueryParam
Связывает параметр, переданный методу, с параметром запроса в пути.
11
@MatrixParam
Связывает параметр, переданный методу, с параметром матрицы HTTP в пути.
12
@HeaderParam
Связывает параметр, переданный методу, с заголовком HTTP.
13
@CookieParam
Связывает параметр, переданный методу, с файлом cookie.
14
@FormParam
Связывает параметр, переданный методу, со значением формы.
15
@Значение по умолчанию
Назначает значение по умолчанию для параметра, передаваемого методу.
16
@Context
Контекст ресурса. Например, HTTPRequest в качестве контекста.
Примечание. Мы использовали Jersey, эталонную реализацию JAX-RS 2.0 от Oracle, в главах RESTful Web Services — First Application и RESTful Web Services — Methods .