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(apiGroupLP.size>1){%>${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 | Type | Description | Required | Since |
---|---|---|---|---|
${header.name} | ${header.type} | ${htmlEscape(header.desc)} | ${header.required} | ${header.since} |
Path-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
${param.field} | ${param.type} | ${param.desc} | ${param.required} | ${param.version} |
Query-parameters:
Parameter | Type | Description | Required | Since |
---|---|---|---|---|
${param.field} | ${param.type} | ${param.desc} | ${param.required} | ${param.version} |
Body-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}
${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)} |