| Version | Update Time | Status | Author | Description |
|---|---|---|---|---|
${revisionLog.version} | ${revisionLog.revisionTime} | ${revisionLog.status} | ${revisionLog.author} | ${revisionLog.remarks} |
${api.order}.${api.desc}
<%for(doc in api.list){%><%if(isNotEmpty(doc.requestHeaders)){%>
<%}%><%if(isNotEmpty(doc.requestParams)){%>
<%}%><%if(isNotEmpty(doc.requestUsage)){%><%}%><%if(isNotEmpty(doc.responseParams)){%>
<%}%><%if(isNotEmpty(doc.responseUsage)){%><%}%><%}%>
${api.order}.${doc.order} ${doc.desc}
URL:${doc.url}
Type:${doc.type}
Content-Type:${doc.contentType}
Description:${doc.detail}
Request-headers:
| Header | Type | Description | Required | Since |
|---|---|---|---|---|
${header.name} | ${header.type} | ${header.desc} | ${header.required} | ${header.since} |
Request-parameters:
| Parameter | Type | Description | Required | Since |
|---|---|---|---|---|
${param.field} | ${param.type} | ${param.desc} | ${param.required} | ${param.version} |
Request-example:
${doc.requestUsage}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
${param.field} | ${param.type} | ${param.desc} | ${param.version} |
Response-example:
${doc.responseUsage}${apiDocList.~size+1}. ${errorListTitle}
| Error code | Description |
|---|---|
${error.value} | ${error.desc} |