template.html.debug.html Maven / Gradle / Ivy
Show all versions of smart-doc Show documentation
<%if(isNotEmpty(projectName)){%>${projectName} <%}else{%>API Reference <%}%><%if(isNotEmpty(highlightCssLink)){%><%}%><%if(isNotEmpty(projectName)){%>${projectName}
<%}%>API Reference<%for(api in apiDocList){%><%var myStyle="display: none";var liClass="";if(api.order==order){myStyle="display: block";liClass="open";}%><%if(apiLP.first){%>- ${api.order}. ${htmlEscape(api.desc)}
<%for(doc in api.list){%>- <%if(doc.deprecated){%>${api.order}.${doc.order}. ${htmlEscape(doc.desc)}<%}else{%>${api.order}.${doc.order}. ${htmlEscape(doc.desc)}<%}%>
<%}%>
<%}else{%>- ${api.order}. ${htmlEscape(api.desc)}
<%for(doc in api.list){%>- <%if(doc.deprecated){%>${api.order}.${doc.order}. ${htmlEscape(doc.desc)}<%}else{%>${api.order}.${doc.order}. ${htmlEscape(doc.desc)}<%}%>
<%}%>
<%}%><%}%><%if(isNotEmpty(errorCodeList)){%>- ${apiDocList.~size+1}. ${errorListTitle}
<%}%><%if(isNotEmpty(dictList)){%>- ${dictListOrder}. ${dictListTitle}
<%for(dict in dictList){%>- ${dictListOrder}.${dict.order}. ${htmlEscape(dict.title)}
<%}%>
<%}%>
${order}. ${desc}
<%for(doc in list){%><%if(doc.deprecated){%>${order}.${doc.order}. ${htmlEscape(doc.desc)}<%}else{%>${order}.${doc.order}. ${htmlEscape(doc.desc)}<%}%>
URL: ${doc.url}
Type: ${doc.type}
<%if(isNotEmpty(doc.author)){%>Author: ${doc.author}
<%}%>Content-Type: ${doc.contentType}
Description: ${lineBreaksToBr(doc.detail)}
<%if(isNotEmpty(doc.requestHeaders)){%>Request-headers:
Header Value Type Required Description <%for(header in doc.requestHeaders){%>${header.name}
${header.type}
${header.required}
${htmlEscape(header.desc)}
<%}%>
<%}%><%if(isNotEmpty(doc.pathParams)){%>Path-parameters:
Parameter Value Type Required Description <%for(param in doc.pathParams){%>${param.field}
${param.type}
${param.required}
${htmlEscape(param.desc)}
<%}%>
<%}%><%if(isNotEmpty(doc.queryParams)){%>Query-parameters:
Parameter Value Type Required Description <%for(param in doc.queryParams){%>${param.field}
<%if(param.type=="file"&&!param.hasItems){%><%}else if(param.type=="file"&¶m.hasItems){%><%}else{%><%}%>
${param.type}
${param.required}
<%if(param.version!='-'){%> ${htmlEscape(param.desc)}@since ${param.version}
<%}else{%> ${htmlEscape(param.desc)}
<%}%> <%}%>
<%}%><%if(isNotEmpty(doc.requestParams)){%>Body-parameters:
Parameter Type Required Description <%for(param in doc.requestParams){%>${param.field}
${param.type}
${param.required}
<%if(param.version!='-'){%> ${htmlEscape(param.desc)}@since ${param.version}
<%}else{%> ${htmlEscape(param.desc)}
<%}%> <%}%>
<%}%><%if(isNotEmpty(doc.requestExample.jsonBody)&&isRequestExample){%>Request-body:
${doc.requestExample.jsonBody}
<%}%><%if(isNotEmpty(doc.responseParams)){%>Response-fields:
Field Type Description Since <%for(param in doc.responseParams){%>${param.field}
${param.type}
${htmlEscape(param.desc)}
${param.version}
<%}%>
<%}%>
<%if(isNotEmpty(doc.responseUsage)&&isResponseExample){%>Response-example:
${doc.responseUsage}
<%}%><%if(isNotEmpty(doc.requestUsage)&&isRequestExample){%>Curl-example:
${doc.requestUsage}
<%}%><%}%>