| Version | Update Time | Status | Author | Description |
|---|---|---|---|---|
${revisionLog.version} |
${revisionLog.revisionTime} |
${revisionLog.status} |
${revisionLog.author} |
${htmlEscape(revisionLog.remarks)} |
${apiGroup.order}. ${htmlEscape(apiGroup.name)}
<%}%><%for(api in apiGroup.childrenApiDocs){%><%if(!apiDocListOnlyHasDefaultGroup){%>${apiGroup.order}.${api.order}. ${htmlEscape(api.desc)}<%}else{%>${api.order}. ${htmlEscape(api.desc)}<%}%>
<%if(doc.deprecated){%><%if(!apiDocListOnlyHasDefaultGroup){%>${apiGroup.order}.${api.order}.${doc.order}. <%}else{%>${api.order}.${doc.order}. <%}%>${htmlEscape(doc.desc)}<%}else{%><%if(!apiDocListOnlyHasDefaultGroup){%>${apiGroup.order}.${api.order}.${doc.order}. ${htmlEscape(doc.desc)}<%}else{%>${api.order}.${doc.order}. ${htmlEscape(doc.desc)}<%}%><%}%>
URL: ${doc.url}
Type: ${doc.type}
Author: ${doc.author}
Content-Type: ${doc.contentType}
Description: ${htmlEscape(doc.detail)}
Request-headers:
| Header | Value | Type | Required | Description | |
|---|---|---|---|---|---|
${header.name} |
${header.type} |
${header.required} |
${htmlEscape(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"&&!param.hasItems){%><%}else if(param.type=="file"&¶m.hasItems){%><%}else{%><%}%> |
${param.type} |
${param.required} |
<%if(param.version!='-'){%>
${param.desc}@since ${param.version} |
<%}else{%>
${param.desc} |
<%}%>
Body-parameters:
| Parameter | Value | Type | Required | Description | ||
|---|---|---|---|---|---|---|
${param.field} |
<%if(param.type=="file"&&!param.hasItems){%><%}else if(param.type=="file"&¶m.hasItems){%><%}else{%><%}%> |
${param.type} |
${param.required} |
<%if(param.version!='-'){%>
${param.desc}@since ${param.version} |
<%}else{%>
${param.desc} |
<%}%>
Body-parameters:
| Parameter | Type | Required | Description | |
|---|---|---|---|---|
${param.field} |
${param.type} |
${param.required} |
<%if(param.version!='-'){%>
${param.desc}@since ${param.version} |
<%}else{%>
${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}
${errorCodeListOrder}. ${errorListTitle}
| Error code | Description |
|---|---|
${error.value} |
${htmlEscape(error.desc)} |
${dictListOrder}. ${dictListTitle}
${dictListOrder}.${dict.order}. ${htmlEscape(dict.title)}
| Code | Type | Description |
|---|---|---|
${dataDict.value} |
${dataDict.type} |
${htmlEscape(dataDict.desc)} |