Package org.springframework.restdocs.templates

Interface TemplateEngine

All Known Implementing Classes:
MustacheTemplateEngine
public interface TemplateEngine
A TemplateEngine is used to render documentation snippets.
Author:
Andy Wilkinson
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Template
    compileTemplate(String path)
    Compiles the template at the given path.

  • Method Details

    • compileTemplate

      Template compileTemplate(String path) throws IOException
      Compiles the template at the given path. Typically, a TemplateResourceResolver will be used to resolve the path into a resource that can be read and compiled.
      Parameters:
      path - the path of the template
      Returns:
      the compiled Template
      Throws:
      IOException - if compilation fails