template.AllInOne.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(apiGroup in apiDocList){%><%if(!apiDocListOnlyHasDefaultGroup){%><%if(apiGroupLP.first){%>- ${apiGroup.order}.${htmlEscape(apiGroup.group)}
<%for(api in apiGroup.childrenApiDocs){%>- ${apiGroup.order}.${api.order}.${htmlEscape(api.desc)}
<%for(doc in api.list){%>- <%if(doc.deprecated){%>${apiGroup.order}.${api.order}.${doc.order}.${htmlEscape(doc.desc)}<%}else{%>${apiGroup.order}.${api.order}.${doc.order}.${htmlEscape(doc.desc)}<%}%>
<%}%>
<%}%>
<%}else{%>- ${apiGroup.order}.${htmlEscape(apiGroup.group)}
<%for(api in apiGroup.childrenApiDocs){%>- ${apiGroup.order}.${api.order}.${htmlEscape(api.desc)}
<%for(doc in api.list){%>- <%if(doc.deprecated){%>${apiGroup.order}.${api.order}.${doc.order}.${htmlEscape(doc.desc)}<%}else{%>${apiGroup.order}.${api.order}.${doc.order}.${htmlEscape(doc.desc)}<%}%>
<%}%>
<%}%>
<%}%><%}else{%><%if(apiGroupLP.first){%><%for(api in apiGroup.childrenApiDocs){%>- ${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{%><%for(api in apiGroup.childrenApiDocs){%>- ${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)){%>- ${errorCodeListOrder}.${errorListTitle}
<%}%><%if(isNotEmpty(dictList)){%>- ${dictListOrder}.${dictListTitle}
<%for(dict in dictList){%>- ${dictListOrder}.${dict.order}.${dict.title}
<%}%>
<%}%>
<%if(isNotEmpty(revisionLogList)){%>Version Update Time Status Author Description <%for(revisionLog in revisionLogList){%>${revisionLog.version}
${revisionLog.revisionTime}
${revisionLog.status}
${revisionLog.author}
${htmlEscape(revisionLog.remarks)}
<%}%>
<%}%><%for(apiGroup in apiDocList){%><%if(!apiDocListOnlyHasDefaultGroup){%>${apiGroup.order}.${htmlEscape(apiGroup.name)}
<%}%><%for(api in apiGroup.childrenApiDocs){%><%if(apiGroupLP.size>1){%>${apiGroup.order}.${api.order}.${htmlEscape(api.desc)}<%}else{%>${api.order}.${htmlEscape(api.desc)}<%}%>
<%for(doc in api.list){%><%if(doc.deprecated){%><%if(!apiDocListOnlyHasDefaultGroup){%>${apiGroup.order}.${api.order}.${doc.order}.<%}else{%>${api.order}.${doc.order}.<%}%>${htmlEscape(doc.desc)}<%}else{%><%if(!apiDocListOnlyHasDefaultGroup){%>${apiGroup.order}.${api.order}.${doc.order}.${htmlEscape(doc.desc)}<%}else{%>${api.order}.${doc.order}.${htmlEscape(doc.desc)}<%}%><%}%>
URL: ${doc.url}
Type: ${doc.type}
<%if(isNotEmpty(doc.author)){%>Author: ${doc.author}
<%}%>Content-Type: ${doc.contentType}
Description: ${htmlEscape(doc.detail)}
<%if(isNotEmpty(doc.requestHeaders)&&displayRequestParams){%>Request-headers:
Header Type Description Required Since <%for(header in doc.requestHeaders){%>${header.name}
${header.type}
${htmlEscape(header.desc)}
${header.required}
${header.since}
<%}%>
<%}%><%if(isNotEmpty(doc.pathParams)&&displayRequestParams){%>Path-parameters:
Parameter Type Description Required Since <%for(param in doc.pathParams){%>${param.field}
${param.type}
${param.desc}
${param.required}
${param.version}
<%}%>
<%}%><%if(isNotEmpty(doc.queryParams)&&displayRequestParams){%>Query-parameters:
Parameter Type Description Required Since <%for(param in doc.queryParams){%>${param.field}
${param.type}
${param.desc}
${param.required}
${param.version}
<%}%>
<%}%><%if(isNotEmpty(doc.requestParams)&&displayRequestParams){%>Body-parameters:
Parameter Type Description Required Since <%for(param in doc.requestParams){%>${param.field}
${param.type}
${param.desc}
${param.required}
${param.version}
<%}%>
<%}%><%if(isNotEmpty(doc.requestUsage)&&isRequestExample){%>Request-example:
${doc.requestUsage}
<%}%><%if(isNotEmpty(doc.responseParams)&&displayResponseParams){%>Response-fields:
Field Type Description Since <%for(param in doc.responseParams){%>${param.field}
${param.type}
${param.desc}
${param.version}
<%}%>
<%}%><%if(isNotEmpty(doc.responseUsage)&&isResponseExample){%>Response-example:
${doc.responseUsage}
<%}%><%}%><%}%><%}%><%if(isNotEmpty(errorCodeList)){%>${errorCodeListOrder}.${errorListTitle}
Error code Description <%for(error in errorCodeList){%>${error.value}
${htmlEscape(error.desc)}
<%}%>
<%}%><%if(isNotEmpty(dictList)){%>${dictListOrder}.${dictListTitle}
<%for(dict in dictList){%>${dictListOrder}.${dict.order}.${htmlEscape(dict.title)}
Code Type Description <%for(dataDict in dict.dataDictList){%>${dataDict.value}
${dataDict.type}
${htmlEscape(dataDict.desc)}
<%}%>
<%}%><%}%>Top