template.dubbo.Dubbo.adoc 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


= ${desc}

*URI:* ${uri}

*Service:* ${name}

*Protocol:* ${protocol}

*Author:* ${author}

*Version:* ${version}
<%
for(doc in list){
%>
<%if(doc.deprecated){%>
== ~~${htmlEscape(doc.desc)}~~
<%}else{%>
## ${htmlEscape(doc.desc)}
<%}%>

*Definition：* ${doc.methodDefinition}

<%if(isNotEmpty(doc.author)){%>
*Author:* ${doc.author}
<%}%>

*Description:* ${doc.detail}

<%if(isNotEmpty(doc.requestParams)){%>
*Invoke-parameters:*

[width="100%",options="header"]
[stripes=even]
|====================
|Parameter | Type|Required|Description|Since
<%
for(param in doc.requestParams){
%>
|${param.field}|${param.type}|${param.required}|${htmlEscape(param.desc)}|${param.version}
<%}%>
|====================
<%}%>

<%if(isNotEmpty(doc.responseParams)){%>
*Response-fields:*

[width="100%",options="header"]
[stripes=even]
|====================
|Field | Type|Description|Since
<%
for(param in doc.responseParams){
%>
|${param.field}|${param.type}|${htmlEscape(param.desc)}|${param.version}
<%}%>
|====================
<%}%>

<% } %>