restapi-doc.0.0.1.source-code.apidoc.hbs Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of restapi-doc Show documentation

Creates documentation for a spring mvc RESTful api. Output is reStructuredText for sphinx using sphinxcontrib.httpdomain

The newest version!

{{name}}
-------------------------------------------------------------------------

{{description}}


{{#each methods}}


.. http:{{ lower requestMethod}}:: {{path}}

    {{description}}

    {{#each urlparameters}}
    :param {{name}}: {{description}}
    {{/each}}

    {{#each queryParameters}}
    :queryparameter {{name}}: {{description}}
    {{/each}}
    
    {{#if bodyobject}}
    :jsonparameter {{bodyobject.object}}: :ref:`{{bodyobject.object}}-rest`
    {{/if}}

:Returns:  :ref:`{{response.object}}-rest`
    
{{/each}}