Customizing templates

Use custom templates #

When generating a server or client you can specify a directory to load custom templates from with --template-dir. It will recursively read all the .gotmpl files in the directory and load them as templates.

Each file will be loaded and define a template named the same as the file without the suffix. If the file is in a subdirectory the directory name will be included in the template name and the first character of the next path segment will be uppercased. e.g.

  • template.gotmpl -> template
  • server/test.gotmpl -> serverTest

You can override the following templates. Check go-swagger/generator/templates for the default definitions.

Available Templates #

Client Templates #

clientFacade #

Defined in client/facade.gotmpl

clientResponse #

Defined in client/response.gotmpl ####requires

  • clientresponse
  • schema
  • docstring

clientClient #

Defined in client/client.gotmpl

Server Templates #

serverParameter #

Defined in server/parameter.gotmpl ####requires

  • propertyparamvalidator
  • sliceparambinder

serverResponses #

Defined in server/responses.gotmpl ####requires

  • serverresponse

serverresponse #

Defined in server/responses.gotmpl

propertyparamvalidator #

Defined in server/parameter.gotmpl ####requires

  • validationPrimitive
  • sliceparamvalidator

bindprimitiveparam #

Defined in server/parameter.gotmpl

serverBuilder #

Defined in server/builder.gotmpl

Copyright 2015-2024 the go-swagger maintainers. This documentation is under an Apache 2.0 license.

Site built with HUGO using hugo-book