Skip to content

Commit

Permalink
made a start at the docs for the REST client
Browse files Browse the repository at this point in the history
  • Loading branch information
graemerocher committed Sep 6, 2013
1 parent 920b269 commit 956d406
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 0 deletions.
3 changes: 3 additions & 0 deletions grails-documentation-rest-client/build.gradle
@@ -0,0 +1,3 @@
task assemble(dependsOn:docs) << {
group = "docs"
}
3 changes: 3 additions & 0 deletions grails-documentation-rest-client/src/docs/doc.properties
@@ -0,0 +1,3 @@
title=GORM REST Client
version=1.0.0.M1
authors=Graeme Rocher
@@ -0,0 +1 @@
The GORM REST Client plugin tries to provide a GORM-like API to interact with REST Web Services. Building on the REST features of Grails 2.3.x, this plugin works only with Grails 2.3.x and above. Note that in its current state the GORM REST Client plugin only implements basic CRUD operations and should be seen as convenience for easily converting between REST representations and a domain model rather than a full object mapping tool.
@@ -0,0 +1,5 @@
Below are the details of the changes across releases:

h4. 1.0 M1

* Initial release
@@ -0,0 +1,14 @@
To get started with GORM REST Client configure it as a dependency in @BuildConfig.groovy@:

{code}
plugins {
compile ':gorm-rest-client:1.0.0.M1' // or whatever is the latest vesrion
}
{code}

Note that the above assumes you do not have Hibernate installed. If you do have Hibernate installed then domain classes will be by default mapped with Hibernate. If you want to a domain class to be a REST entity. Then you are required to add the following mapping:

{code}
static mapWith = "restclient"
{code}

@@ -0,0 +1 @@
GORM REST client is designed to work in seamlessly with Grails 2.3's [new REST support|http://grails.org/doc/2.3.x/guide/webServices.html#REST].

0 comments on commit 956d406

Please sign in to comment.