RestApiDoc Plugin

  • Tags: /
  • Latest: 0.3.1
  • Last Updated: 11 September 2014
  • Grails version: 2.3 > *
2 votes
Dependency:
compile ":rest-api-doc:0.3.1"

 Documentation  Source  Issues

Summary

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,...)

Description

Further documentation can be found here.