You define a base URI and the name of the controller to map to using the parameter. The above mapping will result in the following URLs:
If you are not sure which mapping will be generated for your case just run the command url-mappings-report
in your grails console. It will give you a really neat report for all the url mappings.
If you wish to include or exclude any of the generated URL mappings you can do so with the includes
or excludes
parameter, which accepts the name of the Grails action to include or exclude:
"/books"(resources:'book', excludes:['delete', 'update'])
or
"/books"(resources:'book', includes:['index', 'show'])
Explicit REST Mappings
As of Grails 3.1, if you prefer not to rely on a resources
mapping to define your mappings then you can prefix any URL mapping with the HTTP method name (in lower case) to indicate the HTTP method it applies to. The following URL mapping:
"/books"(resources:'book')
Is equivalent to:
get "/books/create"(controller:"book", action:"create")
post "/books"(controller:"book", action:"save")
get "/books/$id/edit"(controller:"book", action:"edit")
put "/books/$id"(controller:"book", action:"update")
delete "/books/$id"(controller:"book", action:"delete")
Notice how the HTTP method name is prefixed prior to each URL mapping definition.
Single resources
A single resource is a resource for which there is only one (possibly per user) in the system. You can create a single resource using the single
parameter (as opposed to resources
):
The main difference is that the id is not included in the URL mapping.
Nested Resources
You can nest resource mappings to generate child resources. For example:
"/books"(resources:'book') {
"/authors"(resources:"author")
}
The above will result in the following URL mappings:
You can also nest regular URL mappings within a resource mapping:
"/books"(resources: "book") {
}
This will result in the following URL being available:
To map a URI directly below a resource then use a collection block:
"/books"(resources: "book") {
collection {
}
}
This will result in the following URL being available (without the ID):
Linking to RESTful Mappings
As a convenience you can also pass a domain instance to the resource
attribute of the link
tag:
<g:link resource="${book}">My Link</g:link>
This will automatically produce the correct link (in this case "/books/1" for an id of "1").
The case of nested resources is a little different as they typically required two identifiers (the id of the resource and the one it is nested within). For example given the nested resources:
"/books"(resources:'book') {
"/authors"(resources:"author")
}
If you wished to link to the show
action of the author
controller, you would write:
<g:link controller="author" action="show" method="GET" params="[bookId:1]" id="2">The Author</g:link>
However, to make this more concise there is a attribute to the link tag which can be used instead:
The resource attribute accepts a path to the resource separated by a slash (in this case "book/author"). The attributes of the tag can be used to specify the necessary bookId
parameter.