Halapino creates HAL-compliant HATEOAS JSON within dropwizard apps.
Halapino takes your standard dropwizard representation object and wraps it up in a HALRepresentation. This is serialised by Jackson with the help of a couple of custom serialisers.
If you have not seen the existing Java HAL implementations, find them by following the links on the main HAL page. Current implementations include:
- halbuilder
- halarious
- hyperexpress
While these implementations are more complete (Halapino does not have a deserialiser, for example), Halapino has been specifically designed to work with dropwizard. It:
- Uses Jackson for JSON serialisation (utilising Jackson annotations and a couple of custom serialisers to do most of the work);
- Uses Jersey resource path configuration to reduce the amount of HAL-specific configuration (following the DRY principle);
- Uses the uriInfo object injected by Jersey to generate absolute links;
- Can be added to existing resources with just a few changes - a couple of annotations and some setup code are all you need to get going.
Check out the wiki for information on getting started.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.