https://github.com/fasterxml/jackson-jakarta-rs-providers
Multi-module project that contains Jackson-based "new" Jakarta-RS (nee "JAX-RS" -- ones under `jakarta.ws.rs`) providers for JSON, XML, YAML, Smile, CBOR formats
https://github.com/fasterxml/jackson-jakarta-rs-providers
Last synced: 27 days ago
JSON representation
Multi-module project that contains Jackson-based "new" Jakarta-RS (nee "JAX-RS" -- ones under `jakarta.ws.rs`) providers for JSON, XML, YAML, Smile, CBOR formats
- Host: GitHub
- URL: https://github.com/fasterxml/jackson-jakarta-rs-providers
- Owner: FasterXML
- License: apache-2.0
- Created: 2021-05-29T16:58:49.000Z (almost 4 years ago)
- Default Branch: 2.19
- Last Pushed: 2025-03-28T23:54:47.000Z (about 1 month ago)
- Last Synced: 2025-03-29T00:28:01.966Z (about 1 month ago)
- Language: Java
- Size: 1.06 MB
- Stars: 14
- Watchers: 5
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Overview
This is a multi-module project that contains Jackson-based Jakarta-RS (*) providers
for following data formats:
* [JSON](https://github.com/FasterXML/jackson-core)
* [Smile](https://github.com/FasterXML/jackson-dataformat-smile) (binary JSON)
* [CBOR](https://github.com/FasterXML/jackson-dataformat-cbor) (another kind of binary JSON)
* [XML](https://github.com/FasterXML/jackson-dataformat-xml)
* [YAML](https://github.com/FasterXML/jackson-dataformat-yaml)
Providers implement Jakarta-RS `MessageBodyReader` and `MessageBodyWriter` handlers for specific
data formats. They also contain SPI settings for auto-registration.
[](https://travis-ci.org/FasterXML/jackson-jakarta-rs-providers)
[](https://maven-badges.herokuapp.com/maven-central/com.fasterxml.jackson.jakarta.rs/jackson-jakarta-rs-json-provider/)
[](https://www.javadoc.io/doc/com.fasterxml.jackson.jakarta.rs/jackson-jakarta-rs-json-provider)
(*) NOTE: Jakarta-RS is the package under `jakarta.ws.rs`, replacing older JAX-RS which lived
under `javax.ws.rs`.
For JAX-RS variant, see repo [jackson-jaxrs-providers](../../../jackson-jaxrs-providers)
## Build
Usual Maven build like other Jackson repos, with one difference: requires JDK 11 to build
(as opposed to JDK 8 for most other repos), as of Jackson 2.13
## Status
Module is fully functional and considered mature.
## Maven dependency
To use Jakarta-RS on Maven-based projects, use dependencies like:
```xml
com.fasterxml.jackson.jakarta.rs
jackson-jakarta-rs-json-provider
2.14.1
```
(above is for JSON provider; modify appropriately for other providers)
## Usage: registering providers
Due to auto-registration, it should be possible to simply add Maven dependency
(or include jar if using other build systems) and let Jakarta-RS implementation discover
provider.
If this does not work you need to consult documentation of the Jakarta-RS implementation for details.
To use Jackson with Jersey see [their documentation](https://jersey.github.io/documentation/latest/media.html#json.jackson).
### Annotations on resources
In addition to annotation value classes, it is also possible to use a subset
of Jackson annotations with provider.
Here is a short list of supported annotations that work with all formats:
* `@JsonView` can be used to define active view for specific endpoint
* `@JsonRootName` can be used to specify alternate rootname; most often used with XML, but possibly with JSON as well.
* `@JacksonAnnotationsInside` meta-annotation may be used as a marker, to create "annotation bundles", similar to how they are used with value type annotations
* `com.fasterxml.jackson.jakarta.rs.annotation.JacksonFeatures` can be used with all provid to enable/disable
* `SerializationFeature` / `DeserializationFeature` for data-binding configuration
* `JsonParser.Feature` / `JsonGenerator.Feature` for low(er) level Streaming read/write options
In addition there are format-specific annotations that may be used:
* JSON has:
* `com.fasterxml.jackson.jakarta.rs.json.annotation.JSONP` to define `JSONP` wrapping for serialized result
## Support
### Community support
Jackson components are supported by the Jackson community through mailing lists, Gitter forum, Github issues. See [Participation, Contributing](../../../jackson#participation-contributing) for full details.
### Enterprise support
Support may be added via Tidelift Subscription model, if there is enough interest.
-----
## Other
For documentation, downloads links, check out [Wiki](../../wiki)