wanjia950611
/
smart-doc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update template for markdown

This commit is contained in:
oppofind 2019-09-27 22:46:52 +08:00
parent fa2e1efe1f
commit 59e9d574c1
2 changed files with 22 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/main/resources/template/AllInOne.btl
View File

@ -1,6 +1,6 @@
<%if(isNotEmpty(revisionLogList)){%>
Version | Update Time | Status | Author | Description
------|--------|-----|------| -------
------|--------|-----|------|-------
<%
for(revisionLog in revisionLogList){
%>
@ -37,9 +37,12 @@ ${doc.headers}
Parameter | Type|Description|Required|Since
---|---|---|---|---
${doc.requestParams}
<%
for(param in doc.requestParams){
%>
${param.field}|${param.type}|${param.desc}|${param.required}|${param.version}
<%}%>
<%}%>
<%if(isNotEmpty(doc.requestUsage)){%>
**Request-example:**
```
@ -51,7 +54,11 @@ ${doc.requestUsage}
Field | Type|Description|Since
---|---|---|---
${doc.responseParams}
<%
for(param in doc.responseParams){
%>
${param.field}|${param.type}|${param.desc}|${param.version}
<%}%>
<%}%>
<%if(isNotEmpty(doc.responseUsage)){%>

14
src/main/resources/template/ApiDoc.btl
View File

@ -21,9 +21,13 @@ ${doc.headers}
<%if(isNotEmpty(doc.requestParams)){%>
**Request-parameters:**
Parameter | Type|Description|Required|Since
Parameter|Type|Description|Required|Since
---|---|---|---|---
${doc.requestParams}
<%
for(param in doc.requestParams){
%>
${param.field}|${param.type}|${param.desc}|${param.required}|${param.version}
<%}%>
<%}%>
<%if(isNotEmpty(doc.requestUsage)){%>
@ -37,7 +41,11 @@ ${doc.requestUsage}
Field | Type|Description|Since
---|---|---|---
${doc.responseParams}
<%
for(param in doc.responseParams){
%>
${param.field}|${param.type}|${param.desc}|${param.version}
<%}%>
<%}%>
<%if(isNotEmpty(doc.responseUsage)){%>