| Version | Update Time | Status | Author | Description |
|---|---|---|---|---|
${revisionLog.version} | ${revisionLog.revisionTime} | ${revisionLog.status} | ${revisionLog.author} | ${revisionLog.remarks} |
${api.order}. ${api.desc}
<%if(doc.deprecated){%>${api.order}.${doc.order}. ${doc.desc}<%}else{%>${api.order}.${doc.order}. ${doc.desc}<%}%>
URL: ${doc.url}
Type: ${doc.type}
Author: ${doc.author}
Content-Type: ${doc.contentType}
Description: ${doc.detail}
Request-headers:
| Header | Value | Type | Required | Description | |
|---|---|---|---|---|---|
${header.name} | ${header.type} | ${header.required} | ${header.desc} |
Path-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
${param.field} | ${param.type} | ${param.required} | ${param.desc} |
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
${param.field} | <%if(param.type=="file"){%><%}else{%><%}%> | ${param.type} | ${param.required} | ${param.desc} |
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
${param.field} | ${param.type} | ${param.required} | ${param.desc} |
Request-body:
${doc.requestExample.jsonBody}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
${param.field} | ${param.type} | ${param.desc} | ${param.version} |
Response-example:
${doc.responseUsage}Curl-example:
${doc.requestUsage}${apiDocList.~size+1}. ${errorListTitle}
| Error code | Description |
|---|---|
${error.value} | ${error.desc} |
${dictListOrder}. ${dictListTitle}
${dictListOrder}.${dict.order}. ${dict.title}
| Code | Type | Description |
|---|---|---|
${dataDict.value} | ${dataDict.type} | ${dataDict.desc} |