[jackson-jaxrs-providers] 140/162: Update README to denote annotations usable on endpoints

Timo Aaltonen tjaalton at moszumanska.debian.org
Mon Sep 8 22:16:37 UTC 2014


This is an automated email from the git hooks/post-receive script.

tjaalton pushed a commit to branch master
in repository jackson-jaxrs-providers.

commit 47fc54ea8379d40a32e57d3221aedd645c0b7b5b
Author: Tatu <tsaloranta at gmail.com>
Date:   Wed Apr 23 11:22:24 2014 -0700

    Update README to denote annotations usable on endpoints
---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/README.md b/README.md
index b300d7d..17a0525 100644
--- a/README.md
+++ b/README.md
@@ -37,6 +37,25 @@ Due to auto-registration, it should be possible to simply add Maven dependency
 provider.
 If this does not work you need to consult documentation of the JAX-RS implementation for details.
 
+### Annotations on resources
+
+In addition to annotation value classes, it is also possible to use a subset
+of Jackson annotations with provider (versions 2.3.0 and above).
+
+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.jaxrs.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.jaxrs.json.annotation.JSONP` to define `JSONP` wrapping for serialized result
+
 ## Other
 
 For documentation, downloads links, check out [Wiki](../../wiki)

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-java/jackson-jaxrs-providers.git



More information about the pkg-java-commits mailing list