Plugins You can find out about all the publicly available Grails plugins.

RestApiDoc Plugin

  • Tags: rest, documentation
  • Latest: 0.6.1
  • Last Updated: 23 January 2015
  • Grails version: 2.3 > *
2 votes
compile ":rest-api-doc:0.6.1"

 Documentation  Source  Issues


The RestApiDoc plugin allows to document your Grails Rest API. Thanks to some Annotations (@), you will be ready to build a full API report (with a playground to perform test request). The plugin is based on jsondoc.

This plugin allows you to document methods (description, HTTP path/verb, parameters, response type...) and resources (description, all fields,...). It does a lot of stuff for you (computing path/verb for the method, retrieving field type,...)


Further documentation can be found here.