All Downloads are FREE. Search and download functionalities are using the official Maven repository.

enjianjx.swagger2html.2.0.0.source-code.single-html.ftl Maven / Gradle / Ivy

There is a newer version: 2.0.3
Show newest version
<#escape x as (x!)?html>
 							
		<#macro showModelRows rows>	 
			<#if (rows?size > 0) >
				
					<#list rows as row>
						
Property Type Description Format Required ReadOnly
${row.getOgnlPath()} ${row.getTypeStr()} ${row.getProperty().getDescription()} ${row.getProperty().getFormat()} ${row.getProperty().getRequired()?string('Y', 'N')} <#if row.getProperty().getReadOnly()??> ${row.getProperty().getReadOnly()?string('Y', 'N')}
<#noescape> ${css} ${sw.getTitle()}

${sw.getTitle()}

Information

<#if sw.getBaseUrls()??> <#if sw.swagger.getInfo()??> <#if sw.swagger.getInfo().getDescription()??> <#if sw.swagger.getInfo().getContact()??> <#if sw.swagger.getInfo().getContact().getName()??> <#if sw.swagger.getInfo().getContact().getEmail()??> <#if sw.swagger.getInfo().getContact().getUrl()??> <#if sw.swagger.getInfo().getLicense()??> <#if sw.swagger.getInfo().getTermsOfService()??>
Base URL <#list sw.getBaseUrls() as baseUrl>

${baseUrl}

Version ${sw.swagger.getInfo().getVersion()}
Description <#noescape> ${sw.getDescription()!}
Contact Name${sw.swagger.getInfo().getContact().getName()}
Contact Email${sw.swagger.getInfo().getContact().getEmail()}
Contact URL${sw.swagger.getInfo().getContact().getUrl()}
License ${sw.swagger.getInfo().getLicense().getName()}
Terms Of Service ${sw.swagger.getInfo().getTermsOfService()}

Table of Contents

<#if sw.getTags()??> <#list sw.getTags() as tag>

${tag.getName()}

${tag.getDescription()}

<#list sw.getOperationIdsOfTag(tag.getName()) as operationId>
Index Method Path Summary
${operationId_index + 1} ${operationId.getMethod()} ${operationId.getPath()} <#if sw.getOperation(operationId)??> ${sw.getOperation(operationId).getSummary()}
<#if sw.getTags()??> <#list sw.getTags() as tag>

${tag.getName()}

<#list sw.getOperationIdsOfTag(tag.getName()) as operationId>

${operationId.getMethod()} ${operationId.getPath()}

Summary ${sw.getOperation(operationId).getSummary()}
Notes ${sw.getOperation(operationId).getDescription()}
Consumes ${displayList(sw.getOperation(operationId).getConsumes())}
Produces ${displayList(sw.getOperation(operationId).getProduces())}

Parameters

<#if (sw.getOperation(operationId).getParameters()?? && (sw.getOperation(operationId).getParameters()?size > 0)) >
<#list sw.getOperation(operationId).getParameters() as param>
Name Parameter Type Data Type Required Description
${param.getName()} ${param.getIn()}
${paramTypeStr(param, operationId)}
<@showModelRows rows=paramToModelRows(param, operationId)/>
${param.getRequired()?string('Y', 'N')} ${param.getDescription()}
<#else> No Parameters

Responses

<#if sw.getOperation(operationId).getResponses()??> <#list sw.getOperation(operationId).getResponses()?keys as httpCode>
HTTP Status Code Reason Response Type
${httpCode} ${sw.getOperation(operationId).getResponses()[httpCode] .getDescription()} <#if sw.getOperation(operationId).getResponses()[httpCode].getSchema()??>
${propertyTypeStr(sw.getOperation(operationId).getResponses()[httpCode].getSchema(), opeartionId)}
<@showModelRows rows=propertyToModelRows(sw.getOperation(operationId).getResponses()[httpCode].getSchema(), opeartionId)/>




© 2015 - 2025 Weber Informatics LLC | Privacy Policy