class Analyzer::Groovy::Grails

• Analyzer::Groovy::Grails
• Analyzer
• Reference
• Object

Overview

Grails follows a convention-over-configuration layout where each controller class under grails-app/controllers/ exposes its action methods as URL endpoints. The default URL mapping is "/$controller/$action?/$id?(.$format)?", so we surface every action method as /<controller>/<action> (the controller name is the class name with the Controller suffix dropped and the first letter lowercased).

Two action styles are handled:

• Method form: def show() { ... }
• Closure form: def show = { ... } (legacy Grails)

When the controller declares static allowedMethods = [save: 'POST', update: ['PUT', 'PATCH']] those restrictions are honored; otherwise actions are emitted as GET (the default Grails dispatch verb when no restriction is set).

grails-app/conf/UrlMappings.groovy is also scanned for explicit string-based mappings of the form get '/api/users'(controller: 'user', action: 'list') which are surfaced as additional endpoints.

Defined in:

Constant Summary

DEFAULT_METHODS = ["GET"]

HTTP_METHODS = ["GET", "POST", "PUT", "DELETE", "PATCH", "HEAD", "OPTIONS"] of ::String

RESOURCES_ENDPOINTS = [{suffix: "", method: "GET"}, {suffix: "", method: "POST"}, {suffix: "/:id", method: "GET"}, {suffix: "/:id", method: "PUT"}, {suffix: "/:id", method: "PATCH"}, {suffix: "/:id", method: "DELETE"}]

Endpoints generated by (resources: "name") shortcuts in UrlMappings.groovy. Each tuple is suffix appended to the base URL plus the verb.

RESTFUL_ACTIONS = [{name: "index", method: "GET"}, {name: "show", method: "GET"}, {name: "save", method: "POST"}, {name: "update", method: "PUT"}, {name: "patch", method: "PATCH"}, {name: "delete", method: "DELETE"}]

Actions inherited from RestfulController<T> (Grails REST base).

SCAFFOLD_ACTIONS = [{name: "index", method: "GET"}, {name: "show", method: "GET"}, {name: "create", method: "GET"}, {name: "save", method: "POST"}, {name: "edit", method: "GET"}, {name: "update", method: "PUT"}, {name: "delete", method: "DELETE"}]

Actions added implicitly by static scaffold = X (Grails legacy CRUD scaffolding).

SKIP_ACTION_NAMES = ["beforeInterceptor", "afterInterceptor", "afterView", "allowedMethods", "scaffold", "defaultAction", "errors", "response", "request", "params", "responseFormats", "namespace", "transactional"] of ::String

Instance Method Summary

• #analyze

Instance Method Detail