<!DOCTYPE html><html lang="en"><head><meta charset="UTF-8"><meta content="width=device-width, initial-scale=1.0" name="viewport"><meta content="smart-doc" name="generator"><%if(isNotEmpty(projectName)){%><title>${projectName}</title><%}else{%><title>API Reference</title><%}%><link rel="stylesheet" href="font.css"><link rel="stylesheet" href="AllInOne.css?v=${version}"/><%if(isNotEmpty(highlightCssLink)){%><link rel="stylesheet" href="${highlightCssLink}"><%}%><style>.literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:${background}}.hljs{padding:0em}</style><script src="highlight.min.js"></script><script src="jquery.min.js"></script></head><body class="book toc2 toc-left"><div id="header"><%if(isNotEmpty(projectName)){%><h1>${projectName}</h1><%}%><div class="toc2" id="toc"><div id="book-search-input"><input id="search" placeholder="Type to search" type="text"></div><div id="toctitle"><span>API Reference</span></div><ul class="sectlevel1" id="accordion"><%for(api in apiDocList){%><%var myStyle="display: none";var liClass="";if(api.order==order){myStyle="display: block";liClass="open";}%><%if(apiLP.first){%><li class="${liClass}"><a class="dd" href="${api.alias}.html#header">${api.order}.&nbsp;${htmlEscape(api.desc)}</a><ul class="sectlevel2" style="${myStyle}"><%for(doc in api.list){%><li><%if(doc.deprecated){%><a href="${api.alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}.&nbsp;<span class="line-through">${htmlEscape(doc.desc)}</span></a><%}else{%><a href="${api.alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}.&nbsp;${htmlEscape(doc.desc)}</a><%}%></li><%}%></ul></li><%}else{%><li class="${liClass}"><a class="dd" href="${api.alias}.html#header">${api.order}.&nbsp;${htmlEscape(api.desc)}</a><ul class="sectlevel2" style="${myStyle}"><%for(doc in api.list){%><li><%if(doc.deprecated){%><a href="${api.alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}.&nbsp;<span class="line-through">${htmlEscape(doc.desc)}</span></a><%}else{%><a href="${api.alias}.html#_${api.order}_${doc.order}_${doc.desc}">${api.order}.${doc.order}.&nbsp;${htmlEscape(doc.desc)}</a><%}%></li><%}%></ul></li><%}%><%}%><%if(isNotEmpty(errorCodeList)){%><li><a href="error.html#header">${apiDocList.~size+1}.&nbsp;${errorListTitle}</a></li><%}%><%if(isNotEmpty(dictList)){%><li><a class="dd" href="dict.html#header">${dictListOrder}.&nbsp;${dictListTitle}</a><ul class="sectlevel2"><%for(dict in dictList){%><li><a href="dict.html#_${dictListOrder}_${dict.order}_${dict.title}">${dictListOrder}.${dict.order}.&nbsp;${htmlEscape(dict.title)}</a></li><%}%></ul></li><%}%></ul></div></div><div id="content"><div class="sect1"><h2 id="_${desc}"><a class="anchor" href="#_${desc}"></a><a class="link" href="#_${desc}">${order}.&nbsp;${desc}</a></h2><div class="sectionbody"><%for(doc in list){%><div class="sect2"><h3 id="_${order}_${doc.order}_${doc.desc}"><a class="anchor" href="#_${order}_${doc.order}_${doc.desc}"></a><%if(doc.deprecated){%><a class="link" href="#_${order}_${doc.order}_${doc.desc}">${order}.${doc.order}.&nbsp;<span class="line-through">${htmlEscape(doc.desc)}</span></a><%}else{%><a class="link" href="#_${order}_${doc.order}_${doc.desc}">${order}.${doc.order}.&nbsp;${htmlEscape(doc.desc)}</a><%}%></h3><div class="paragraph" data-download="${doc.download}" data-page="${doc.page}" data-url="${doc.url}" id="${doc.methodId}-url"><p><strong>URL:</strong><a class="bare" href="${doc.url}">&nbsp;${doc.url}</a></p></div><div class="paragraph" data-method="${doc.type}" id="${doc.methodId}-method"><p><strong>Type:</strong>&nbsp;${doc.type}</p></div><%if(isNotEmpty(doc.author)){%><div class="paragraph"><p><strong>Author:</strong>&nbsp;${doc.author}</p></div><%}%><div class="paragraph" data-content-type="${doc.contentType}" id="${doc.methodId}-content-type"><p><strong>Content-Type:</strong>&nbsp;${doc.contentType}</p></div><div class="paragraph"><p><strong>Description:</strong>&nbsp;${lineBreaksToBr(doc.detail)}</p></div><%if(isNotEmpty(doc.requestHeaders)){%><div class="paragraph"><p><strong>Request-headers:</strong></p></div><table class="tableblock frame-all grid-all spread"><colgroup><col style="width: 5%;"><col style="width: 19%;"><col style="width: 19%;"><col style="width: 19%;"><col style="width: 19%;"><col style="width: 19%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top"><div class="checkbox"><input checked="checked" class="check-all" id="${doc.methodId}-header-checkbox" name="${doc.methodId}-header-checkbox" type="checkbox"><label for="${doc.methodId}-header-checkbox"></label></div></th><th class="tableblock halign-left valign-top">Header</th><th class="tableblock halign-left valign-top">Value</th><th class="tableblock halign-left valign-top">Type</th><th class="tableblock halign-left valign-top">Required</th><th class="tableblock halign-left valign-top">Description</th></tr></thead><tbody id="${doc.methodId}-header"><%for(header in doc.requestHeaders){%><tr><td class="tableblock halign-left valign-top"><div class="checkbox"><input checked="checked" id="${doc.methodId}-header-${header.name}" name="${doc.methodId}-header-checkbox" type="checkbox"><label for="${doc.methodId}-header-${header.name}"></label></div></td><td class="tableblock halign-left valign-top"><p class="tableblock">${header.name}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><input name="${header.name}" type="text" value="${header.value}"/></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">${header.type}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">${header.required}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">${htmlEscape(header.desc)}</p></td></tr><%}%></tbody></table><%}%><%if(isNotEmpty(doc.pathParams)){%><div class="paragraph"><p><strong>Path-parameters:</strong></p></div><table class="tableblock frame-all grid-all spread"><colgroup><col style="width: 5%;"><col style="width: 19%;"><col style="width: 19%;"><col style="width: 19%;"><col style="width: 19%;"><col style="width: 19%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top"><div class='checkbox'><input checked="checked" class="check-all" id="${doc.methodId}-path-checkbox" name="${doc.methodId}-path-checkbox" type="checkbox"><label for='${doc.methodId}-path-checkbox'></label></div></th><th class="tableblock halign-left valign-top">Parameter</th><th class="tableblock halign-left valign-top">Value</th><th class="tableblock halign-left valign-top">Type</th><th class="tableblock halign-left valign-top">Required</th><th class="tableblock halign-left valign-top">Description</th></tr></thead><tbody id="${doc.methodId}-path-params"><%for(param in doc.pathParams){%><tr><td class="tableblock halign-left valign-top"><div class="checkbox"><input checked="checked" id="${doc.methodId}-path-${param.field}" name="${doc.methodId}-path-checkbox" type="checkbox"><label for="${doc.methodId}-path-${param.field}"></label></div></td><td class="tableblock halign-left valign-top"><p class="tableblock">${param.field}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><input name="${param.field}" type="text" value="${param.value}"/></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">${param.type}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">${param.required}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">${htmlEscape(param.desc)}</p></td></tr><%}%></tbody></table><%}%><%if(isNotEmpty(doc.queryParams)){%><div class="paragraph"><p><strong>Query-parameters:</strong></p></div><table class="tableblock frame-all grid-all spread"><colgroup><col style="width: 5%;"><col style="width: 19%;"><col style="width: 19%;"><col style="width: 19%;"><col style="width: 19%;"><col style="width: 19%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top"><div class='checkbox'><input checked="checked" class="check-all" id="${doc.methodId}-query-checkbox" name="${doc.methodId}-query-checkbox" type="checkbox"><label for="${doc.methodId}-query-checkbox"></label></div></th><th class="tableblock halign-left valign-top">Parameter</th><th class="tableblock halign-left valign-top">Value</th><th class="tableblock halign-left valign-top">Type</th><th class="tableblock halign-left valign-top">Required</th><th class="tableblock halign-left valign-top">Description</th></tr></thead><tbody id="${doc.methodId}-query-params"><%for(param in doc.queryParams){%><tr><td class="tableblock halign-left valign-top"><div class='checkbox'><input checked="checked" id="${doc.methodId}-query-${param.field}" name="${doc.methodId}-query-checkbox" type="checkbox"><label for="${doc.methodId}-query-${param.field}"></label></div></td><td class="tableblock halign-left valign-top"><p class="tableblock">${param.field}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock"><%if(param.type=="file"){%><input name="${param.field}" type="file" value="${param.value}"/><%}else{%><input name="${param.field}" type="text" value="${param.value}"/><%}%></p></td><td class="tableblock halign-left valign-top"><p class="tableblock">${param.type}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">${param.required}</p></td><%if(param.version!='-'){%><td class="tableblock halign-left valign-top"><p class="tableblock">${htmlEscape(param.desc)}@since ${param.version}</p></td><%}else{%><td class="tableblock halign-left valign-top"><p class="tableblock">${htmlEscape(param.desc)}</p></td><%}%></tr><%}%></tbody></table><%}%><%if(isNotEmpty(doc.requestParams)){%><div class="paragraph"><p><strong>Body-parameters:</strong></p></div><table class="tableblock frame-all grid-all spread"><colgroup><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top">Parameter</th><th class="tableblock halign-left valign-top">Type</th><th class="tableblock halign-left valign-top">Required</th><th class="tableblock halign-left valign-top">Description</th></tr></thead><tbody><%for(param in doc.requestParams){%><tr><td class="tableblock halign-left valign-top"><p class="tableblock">${param.field}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">${param.type}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">${param.required}</p></td><%if(param.version!='-'){%><td class="tableblock halign-left valign-top"><p class="tableblock">${htmlEscape(param.desc)}@since ${param.version}</p></td><%}else{%><td class="tableblock halign-left valign-top"><p class="tableblock">${htmlEscape(param.desc)}</p></td><%}%></tr><%}%></tbody></table><%}%><%if(isNotEmpty(doc.requestExample.jsonBody)&&isRequestExample){%><div class="paragraph"><p><strong>Request-body:</strong></p></div><div class="listingblock"><div class="content"><pre><code contenteditable="plaintext-only" id="${doc.methodId}-body">${doc.requestExample.jsonBody}</code></pre></div></div><%}%><%if(isNotEmpty(doc.responseParams)){%><div class="paragraph"><p><strong>Response-fields:</strong></p></div><table class="tableblock frame-all grid-all spread"><colgroup><col style="width: 25%;"><col style="width: 25%;"><col style="width: 25%;"><col style="width: 25%;"></colgroup><thead><tr><th class="tableblock halign-left valign-top">Field</th><th class="tableblock halign-left valign-top">Type</th><th class="tableblock halign-left valign-top">Description</th><th class="tableblock halign-left valign-top">Since</th></tr></thead><tbody><%for(param in doc.responseParams){%><tr><td class="tableblock halign-left valign-top"><p class="tableblock">${param.field}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">${param.type}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">${htmlEscape(param.desc)}</p></td><td class="tableblock halign-left valign-top"><p class="tableblock">${param.version}</p></td></tr><%}%></tbody></table><%}%><div class="paragraph"><p><strong><button class="send-button" data-id="${doc.methodId}">Send Request</button></strong><span id="${doc.methodId}-resp-status"></span></p></div><%if(isNotEmpty(doc.responseUsage)&&isResponseExample){%><div class="paragraph"><p><strong>Response-example:</strong></p></div><div class="listingblock"><div class="content" id="${doc.methodId}-response"><pre><code class="json">${doc.responseUsage}</code></pre></div></div><%}%><%if(isNotEmpty(doc.requestUsage)&&isRequestExample){%><div class="paragraph"><p><strong>Curl-example:</strong></p></div><div class="listingblock"><div class="content" id="${doc.methodId}-curl"><pre><code class="bash">${doc.requestUsage}</code></pre></div></div><%}%></div><%}%></div></div><footer class="page-footer"><span class="copyright">Generated by smart-doc at ${createTime}</span><span class="footer-modification">Suggestions,contact,support and error reporting on<a href="https://gitee.com/smart-doc-team/smart-doc" target="_blank">&nbsp;Gitee</a>&nbsp;or<a href="https://github.com/smart-doc-group/smart-doc.git" target="_blank">&nbsp;Github</a></span></footer></div><script src="debug.js?v=${version}"></script><script src="search.js?v=${version}"></script></body></html>