template.html.index.html Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smart-doc Show documentation
Smart-doc is a tool that supports both JAVA RESTFUL API and Apache Dubbo RPC interface document generation.
There is a newer version: 3.0.5



    
    
    
    <%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}. ${htmlEscape(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:
                <%for(header in doc.requestHeaders){%>
                    
                    <%}%>
                    
                    
                        
                        
                        
                        
                        
                    
                    
                    
                        Header
                        Type
                        Description
                        Required
                        Since
                    
                    
                    
                        ${header.name}
                        ${header.type}
                        ${htmlEscape(header.desc)}
                        ${header.required}
                        ${header.since}
                    
                
                <%}%><%if(isNotEmpty(doc.pathParams)){%>
                Path-parameters:
                <%for(param in doc.pathParams){%>
                    
                    <%}%>
                    
                    
                        
                        
                        
                        
                        
                    
                    
                    
                        Parameter
                        Type
                        Description
                        Required
                        Since
                    
                    
                    
                        ${param.field}
                        ${param.type}
                        ${htmlEscape(param.desc)}
                        ${param.required}
                        ${param.version}
                    
                
                <%}%><%if(isNotEmpty(doc.queryParams)){%>
                Query-parameters:
                <%for(param in doc.queryParams){%>
                    
                    <%}%>
                    
                    
                        
                        
                        
                        
                        
                    
                    
                    
                        Parameter
                        Type
                        Description
                        Required
                        Since
                    
                    
                    
                        ${param.field}
                        ${param.type}
                        ${htmlEscape(param.desc)}
                        ${param.required}
                        ${param.version}
                    
                
                <%}%><%if(isNotEmpty(doc.requestParams)){%>
                Body-parameters:
                <%for(param in doc.requestParams){%>
                    
                    <%}%>
                    
                    
                        
                        
                        
                        
                        
                    
                    
                    
                        Parameter
                        Type
                        Description
                        Required
                        Since
                    
                    
                    
                        ${param.field}
                        ${param.type}
                        ${htmlEscape(param.desc)}
                        ${param.required}
                        ${param.version}
                    
                
                <%}%><%if(isNotEmpty(doc.requestUsage)&&isRequestExample){%>
                Request-example:
                
                    
                        ${doc.requestUsage}
                    
                
                <%}%><%if(isNotEmpty(doc.responseParams)){%>
                Response-fields:
                <%for(param in doc.responseParams){%>
                    
                    <%}%>
                    
                    
                        
                        
                        
                        
                    
                    
                    
                        Field
                        Type
                        Description
                        Since
                    
                    
                    
                        ${param.field}
                        ${param.type}
                        ${htmlEscape(param.desc)}
                        ${param.version}
                    
                
                <%}%><%if(isNotEmpty(doc.responseUsage)&&isResponseExample){%>
                Response-example:
                
                    
                        ${doc.responseUsage}
                    
                
                <%}%>
            
            <%}%>
        
    
    Generated by smart-doc at ${createTime}Suggestions,contact,support and error reporting on Gitee or Github
template.html.index.html Maven / Gradle / Ivy

${projectName}

${order}. ${htmlEscape(desc)}

<%if(doc.deprecated){%>${order}.${doc.order}. ${htmlEscape(doc.desc)}<%}else{%> ${order}.${doc.order}. ${htmlEscape(doc.desc)}<%}%>
