template.dubbo.DubboAllInOne.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(projectName)){%>${projectName}<%}%>
    
        
        API Reference
        
            1. Add dependency
            <%for(api in apiDocList){%><%if(apiLP.first){%>
            ${api.order+1}. ${htmlEscape(api.desc)}
                <%for(doc in api.list){%>
                    <%if(doc.deprecated){%>${api.order+1}.${doc.order}. ${htmlEscape(doc.desc)}<%}else{%>${api.order+1}.${doc.order}. ${htmlEscape(doc.desc)}<%}%>
                    
                    <%}%>
                
            
            <%}else{%>
            ${api.order+1}. ${htmlEscape(api.desc)}
                <%for(doc in api.list){%>
                    <%if(doc.deprecated){%>${api.order+1}.${doc.order}. ${htmlEscape(doc.desc)}<%}else{%>${api.order+1}.${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)}
                    
                    <%}%>
                
            
            <%}%>
        
    

<%if(isNotEmpty(revisionLogList)){%>
    
        
            <%for(revisionLog in revisionLogList){%>
                
                <%}%>
                
                
                    
                    
                    
                    
                    
                
                
                
                    Version
                    Update Time
                    Status
                    Author
                    Description
                
                
                
                    ${revisionLog.version}
                    ${revisionLog.revisionTime}
                    
                    ${revisionLog.status}
                    ${revisionLog.author}
                    ${revisionLog.remarks}
                
            
        
    
    <%}%><%if(isNotEmpty(dependencyList)){%>
    1. Add
        dependency
        
            
                
 <%for(dp in dependencyList){%><dependency>
    <groupId>${dp.groupId}</groupId>
    <artifactId>${dp.artifactId}</artifactId>
    <version>${dp.version}</version>
</dependency>
<%}%>
 
                
            
            <%if(isNotEmpty(consumerConfigExample)){%>
            Consumer config
            
                
                    ${consumerConfigExample}
                
            
            <%}%>
        
    
    <%}%><%for(api in apiDocList){%>
    ${api.order+1}. ${htmlEscape(api.desc)}
    
        
            URI: ${api.uri}
            Service: ${api.name}
            Protocol: ${api.protocol}
            Author: ${api.author}
            Version: ${api.version}
            <%for(doc in api.list){%>
            <%if(doc.deprecated){%>${api.order+1}.${doc.order}. ${htmlEscape(doc.desc)}<%}else{%>${api.order+1}.${doc.order}. ${htmlEscape(doc.desc)}<%}%>
            
                Definition: ${doc.escapeMethodDefinition}
                Description: ${doc.detail}
                <%if(isNotEmpty(doc.requestParams)){%>
                Invoke-parameters:
                <%for(param in doc.requestParams){%>
                    
                    <%}%>
                    
                    
                        
                        
                        
                        
                        
                    
                    
                    
                        Parameter
                        Type
                        Description
                        Required
                        Since
                    
                    
                    
                        ${param.field}
                        ${htmlEscape(param.type)}
                        ${param.desc}
                        ${param.required}
                        ${param.version}
                    
                
                <%}%><%if(isNotEmpty(doc.responseParams)){%>
                Response-fields:
                <%for(param in doc.responseParams){%>
                    
                    <%}%>
                    
                    
                        
                        
                        
                        
                    
                    
                    
                        Field
                        Type
                        Description
                        Since
                    
                    
                    
                        ${param.field}
                        ${htmlEscape(param.type)}
                        ${param.desc}
                        ${param.version}
                    
                
                <%}%>
            
            <%}%>
        
    
    <%}%><%if(isNotEmpty(errorCodeList)){%>
    ${apiDocList.~size+2}. ${errorListTitle}
    
        
            <%for(error in errorCodeList){%>
                
                <%}%>
                
                
                    
                    
                
                
                
                    Error code
                    Description
                
                
                
                    ${error.value}
                    ${htmlEscape(error.desc)}
                    
                
            
        
    
    <%}%><%if(isNotEmpty(dictList)){%>
    ${dictListOrder}. ${dictListTitle}
    
        <%for(dict in dictList){%>
            ${dictListOrder}.${dict.order}. ${htmlEscape(dict.title)}
            
                <%for(dataDict in dict.dataDictList){%>
                    
                    <%}%>
                    
                    
                        
                        
                        
                    
                    
                    
                        Code
                        Type
                        Description
                    
                    
                    
                        ${dataDict.value}
                        ${dataDict.type}
                        
                            ${htmlEscape(dataDict.desc)}
                    
                
            
            <%}%>
        
    
    <%}%>
    Generated by smart-doc at ${createTime}Suggestions,contact,support and error reporting on Gitee or Github
    
    Top