Home

Introduction

grails-jaxrs is a Grails plugin that supports the development of RESTful web services based on the Java API for RESTful Web Services (JSR 311: JAX-RS). It is targeted at developers who want to structure the web service layer of an application in a JSR 311 compatible way but still want to continue to use Grails' powerful features such as GORM, automated XML and JSON marshalling, Grails services, Grails filters and so on. This plugin is an alternative to Grails' built-in mechanism for implementing RESTful web services.

At the moment, plugin users may choose between Jersey and Restlet as JAX-RS implementations. Both implementations are packaged with the plugin. Support for Restlet was added in version 0.2 of the plugin in order to support deployments to Google App Engine. Other JAX-RS implementations such as RestEasy or Apache Wink are likely to be added in upcoming versions of the plugin. Please let us know if you'd like to have them added.

Latest Releases

• Release notes for grails jaxrs version 0.10 (for Grails 2.3.x)
• Release notes for grails jaxrs version 0.9 (for Grails 2.0.x to 2.2.x)

Features

• Makes the JSR 311 (JAX-RS) available to Grails applications for developing RESTful web services.
• New Grails artefact types, Resource and Provider, for JAX-RS classes.
  • JAX-RS Resource classes under grails-app/resources are auto-detected and can be modified at runtime.
  • JAX-RS Provider classes under grails-app/providers are auto-detected and can be modified at runtime.
• Extended Grails command line interface
  • Create new resources and unit test templates via grails create-resource <resource name>.
  • Generate ready-to-use resources from domain objects via grails generate-resources <domain class name>.
• Scaffolding
  • Generate RESTful service interfaces for Grails domain objects.
  • Content negotiation support for XML and JSON representations.
• Ability to use any Grails feature within JAX-RS resources and providers such as
  • GORM can be used [for interacting with persistent domain objects](Advanced Features#using-gorm).
  • Grails filters for intercepting requests to JAX-RS resources.
  • Grails services which can be auto-injected by name.
• Entity providers
  • Domain object providers that convert between Grails domain objects and XML or JSON representations.
  • Support classes for developing custom entity providers.
  • Support for content negotiation based on the Accept request header.
• Easy integration testing of JAX-RS resources and providers.
• Plugin users may choose between Jersey and Restlet as JAX-RS implementations by means of [configuration](Advanced Features#jax-rs-implementation).
• grails-jaxrs applications can be deployed to Google App Engine (GAE).

#Getting started

• If you've used an older version of grails-jaxrs take a look at the Release notes for grails jaxrs version 0.4
• Detailed installation instructions can be found on the Installation Instructions page.
• First steps with the grails-jaxrs plugin are described in the Getting Started guide.
• Advanced grails-jaxrs features are described on the Advanced Features page.