/api-doc-template

mustache templates, used to generate RESTful API Document with the help of Swagger

Primary LanguageHTML

Api Document Template

The templates are mustache templates to generate RESTful API Document with the help of Swagger, they're used by:

  • Swagger Maven Plugin, a maven plugin

    can help you generate swagger API document during build phase using these templates.

  • Ginger, a command line tool

    can help you generate swagger API document using these template as well as any request & response samples for any of your API operations.

There're 5 templates by now:

  1. wiki.mustache for [Confluence](http://en.wikipedia.org/wiki/Confluence_(software\)) wiki markup output.

  2. wiki-new.mustache another [Confluence](http://en.wikipedia.org/wiki/Confluence_(software\)) wiki markup template.

  3. html.mustache for html output, click here to see a sample output.

  4. markdown.mustache for markdown output, click here to see a sample output.

  5. strapdown.html.mustache for HTML output, click here to see a sample output.

    This template actually uses markdown.mustache but generates HTML with the help of Strapdown.js

Welcome to submit new document templates

If you dissatisfy these templates, write your own and do not foget to send pull request

Click here to see the json schema of the data the template consumes.