123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701 |
- <!DOCTYPE html>
- <!--suppress HtmlUnknownAttribute -->
- <!--suppress HtmlUnknownAnchorTarget -->
- <!--suppress HtmlUnknownTarget -->
- <!--suppress HtmlFormInputWithoutLabel -->
- <!--suppress XmlDuplicatedId -->
- <html lang="zh">
- <head>
- <title>API文档</title>
- <meta name="description" content="Bot">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <link href="assets/bootstrap.min.css?v=1751274384094" rel="stylesheet" media="screen">
- <link href="assets/prism.css?v=1751274384094" rel="stylesheet"/>
- <link href="assets/prism-toolbar.css?v=1751274384094" rel="stylesheet"/>
- <link href="assets/prism-diff-highlight.css?v=1751274384094" rel="stylesheet"/>
- <link href="assets/main.css?v=1751274384094" rel="stylesheet" media="screen, print">
- <link href="assets/favicon.ico?v=1751274384094" rel="icon" type="image/x-icon">
- <link href="assets/apple-touch-icon.png?v=1751274384094" rel="apple-touch-icon" sizes="180x180">
- <link href="assets/favicon-32x32.png?v=1751274384094" rel="icon" type="image/png" sizes="32x32">
- <link href="assets/favicon-16x16.png?v=1751274384094" rel="icon" type="image/png" sizes="16x16">
- <style>
- body {
- font-family: Arial, sans-serif;
- margin: 0;
- padding: 0;
- background-color: #f4f4f9;
- }
- .sample-header-content-type-switch {
- padding: 10px;
- border-radius: 5px;
- border: 1px solid #ccc;
- background-color: #fff;
- font-size: 16px;
- cursor: pointer;
- }
- .sidenav > li.active > a {
- background-color: rgba(0, 0, 0, .3);
- color: rgba(255, 255, 255, .7);
- }
- .input-group-addon.sample-request-select {
- padding: 0;
- }
- /* 外部容器 */
- .tabs-container {
- width: 100%;
- /*margin: 30px auto;*/
- /*background-color: white;*/
- /*box-shadow: 0 2px 10px rgba(0, 0, 0, 0.1);*/
- /*border-radius: 8px;*/
- /*padding: 20px;*/
- }
- .nav > li {
- }
- .nav > li > a {
- font-size: 14px;
- }
- .input-group-addon {
- min-width: 75px;
- }
- /* 选项卡头部样式 */
- .tabs-header {
- display: flex;
- height: 45px;
- background-color: transparent;
- border-bottom: 1px solid #ddd;
- margin-top: 5px;
- }
- .method {
- margin: 0 15px 0 0;
- padding: 1px 5px;
- }
- .tab-item {
- min-width: 100px;
- text-align: center;
- padding: 10px;
- cursor: pointer;
- transition: background-color 0.3s;
- font-size: 14px;
- color: #337ab7;
- }
- .tab-item:hover {
- /*background-color: #f0f0f0;*/
- /*color: #000;*/
- text-decoration: none;
- background-color: #eee;
- border-radius: 4px 4px 0 0;
- }
- .tab-item.active:hover {
- cursor: default;
- background-color: #fff;
- }
- .tab-item.active {
- height: 45px;
- border: 1px solid #ddd;
- border-bottom: 1px solid #fff;
- border-radius: 4px 4px 0 0;
- color: #555;
- background-color: #fff;
- }
- .well {
- border: 0;
- background-color: #fff;
- box-shadow: none;
- }
- /* 选项卡内容区域 */
- .tabs-content {
- display: none;
- }
- .tabs-content.active {
- display: block;
- }
- .tab-content {
- padding: 20px;
- background-color: #fff;
- border-radius: 0 0 8px 8px;
- border: 1px solid #ddd;
- border-top: 0;
- }
- #scrollingNav {
- width: 220px;
- background-color: #20222A !important;
- }
- .sidenav > li.nav-header {
- /*margin-top:0;*/
- /*margin-bottom:0;*/
- /*padding-top:8px;*/
- /*padding-bottom:8px;*/
- font-size: 18px;
- margin: 0;
- }
- .sidenav > li.nav-header > a {
- padding: 6.5px 15px;
- font-size: 18px;
- }
- .sidenav:hover {
- scrollbar-width: none !important; /* Firefox 隐藏滚动条 */
- -ms-overflow-style: none !important; /* IE 10+ 隐藏滚动条 */
- }
- .sidenav::-webkit-scrollbar {
- display: none !important; /* 隐藏滚动条(Webkit 浏览器,如 Chrome、Safari) */
- }
- .layui-menu-ul {
- /*box-sizing:border-box;*/
- /*border-radius:2px;font-size:0;*/
- /*color:#fff;*/
- /*position:relative;*/
- /*padding:0;*/
- /*background: 0 0;*/
- /*margin-top:50px;*/
- /*width:220px;*/
- padding-bottom: 60px;
- background-color: rgba(0, 0, 0, .3);
- }
- .layui-nav {
- margin: 0;
- box-sizing: border-box;
- font-size: 0;
- border-radius: 2px;
- color: #fff;
- position: relative;
- padding: 0;
- background: 0 0;
- margin-top: 50px;
- }
- .sidenav > li > a {
- color: rgba(255, 255, 255, .7);
- width: 100%;
- display: block;
- border: 3px solid transparent;
- /*background-color: rgba(0, 0, 0, .3);*/
- }
- .sidenav > li:not(.active,.nav-header) > a:hover {
- box-sizing: border-box;
- border-left: 3px solid #009688;
- color: #fff !important;
- background-color: #20222A;
- transition: all 0.3s;
- }
- .sidenav-search {
- width: 100%;
- position: absolute;
- left: 0;
- background-color: #20222A;
- }
- .search-reset {
- right: 13px;
- }
- .nav-header.nav-list-item > a {
- background-color: #20222A !important;
- }
- .is-new {
- transition: opacity 0.5s ease-in-out;
- opacity: 1;
- visibility: visible;
- }
- .is-new.ws-hidden {
- opacity: 0;
- visibility: hidden;
- max-height: 0;
- }
- .layui-icon-down {
- width: 0;
- height: 0;
- border-left: 6px solid transparent;
- border-right: 6px solid transparent;
- border-top: 6px solid rgba(255, 255, 255, .7);
- position: absolute;
- right: 10px;
- top: 50%;
- }
- .layui-icon-up {
- width: 0;
- height: 0;
- border-left: 6px solid transparent;
- border-right: 6px solid transparent;
- border-bottom: 6px solid rgba(255, 255, 255, .7);
- position: absolute;
- right: 10px;
- top: 50%;
- }
- </style>
- </head>
- <body class="container-fluid">
- <!-- SIDENAV -->
- <script id="template-sidenav" type="text/x-handlebars-template">
- <nav id="scrollingNav" class="col-sm-3 col-lg-2 sidebar-offcanvas">
- <div class="nav-toggle visible-xs">
- <button type="button" class="btn btn-link" data-toggle="offcanvas">
- <span class="sr-only">{{__ "Toggle navigation"}}</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
- </div>
- <div class="sidenav-search">
- <input class="form-control search" data-action='filter-search' type="text" placeholder='{{__ "Filter..."}}'/>
- <span class="search-reset">x</span>
- </div>
- <ul class="sidenav nav nav-list list layui-menu-ul">
- {{#each nav}}
- {{#if title}}
- {{#if isHeader}}
- {{#if isFixed}}
- <li class="nav-fixed nav-header navbar-btn nav-list-item" data-group="{{group}}"><a href="#api-{{group}}" data-name="show-api-{{group}}" class="show-api api-{{group}}-init">{{underscoreToSpace title}}</a></li>
- {{else}}
- <li class="nav-header nav-list-item" data-group="{{group}}"><a href="#api-{{group}}" data-group="show-api-{{group}}" class="show-group api-{{group}}-init">{{underscoreToSpace
- title}}</a><i class="layui-icon layui-icon-down layui-nav-more"></i></li>
- {{/if}}
- {{else}}
- <li class="{{#if hidden}}hide {{/if}}" data-group="{{group}}" data-name="{{name}}" data-version="{{version}}">
- <a href="#api-{{group}}-{{name}}" title="{{url}}" data-group="show-api-{{group}}" data-name="show-api-{{group}}-{{name}}" class="nav-list-item show-api api-{{group}}-{{name}}-init">{{title}}
- <div class="nav-list-url-item hide">{{url}}</div>
- </a>
- </li>
- {{/if}}
- {{/if}}
- {{/each}}
- </ul>
- </nav>
- </script>
- <!-- PROJECT -->
- <script id="template-project" type="text/x-handlebars-template">
- <div class="pull-left">
- <h1>{{name}}</h1>
- {{#if description}}<h2>{{{nl2br description}}}</h2>{{/if}}
- </div>
- <div class="pull-right">
- {{#if template.withCompare}}
- <div class="btn-group">
- <button id="version" class="btn btn-lg btn-default dropdown-toggle" data-toggle="dropdown">
- <strong>{{version}}</strong> <span class="caret"></span>
- </button>
- <ul id="versions" class="dropdown-menu open-left">
- <li><a id="compareAllWithPredecessor" href="#">{{__ "Compare all with predecessor"}}</a></li>
- <li class="divider"></li>
- <li class="disabled"><a href="#">{{__ "show up to version:"}}</a></li>
- {{#each versions}}
- <li class="version"><a href="#">{{this}}</a></li>
- {{/each}}
- </ul>
- </div>
- {{else}}
- <div id="version" class="well well-sm">
- <strong>{{version}}</strong>
- </div>
- {{/if}}
- </div>
- <div class="clearfix"></div>
- </script>
- <script id="template-header" type="text/x-handlebars-template">
- {{#if content}}
- <div id="api-_header" class="show-api-article show-api-_-article">{{{content}}}</div>
- {{/if}}
- </script>
- <script id="template-footer" type="text/x-handlebars-template">
- {{#if content}}
- <div id="api-_footer" class="show-api-article show-api-_-article">{{{content}}}</div>
- {{/if}}
- </script>
- <script id="template-generator" type="text/x-handlebars-template">
- {{#if template.withGenerator}}
- {{#if generator}}
- <div>
- <p class="text-muted">
- {{__ "Generated with"}} <a href="{{{generator.url}}}">{{{generator.name}}}</a> {{{generator.version}}} - {{{generator.time}}}
- </p>
- </div>
- {{/if}}
- {{/if}}
- </script>
- <script id="template-sections" type="text/x-handlebars-template">
- <section id="api-{{group}}" class="show-api-group show-api-{{group}}-group {{#if aloneDisplay}} hide{{/if}}">
- <h1 class="color-primary font-weight-bold">{{underscoreToSpace title}}</h1>
- {{#if description}}
- <p>{{{nl2br description}}}</p>
- {{/if}}
- {{#each articles}}
- <div id="api-{{group}}-{{name}}" class="show-api-article show-api-{{group}}-article show-api-{{group}}-{{name}}-article {{#if aloneDisplay}} hide{{/if}}">
- {{{article}}}
- </div>
- {{/each}}
- </section>
- </script>
- <script id="template-article" type="text/x-handlebars-template">
- <article id="api-{{article.group}}-{{article.name}}-{{article.version}}" class="{{#if hidden}}hide{{/if}}" data-group="{{article.group}}" data-name="{{article.name}}" data-version="{{article.version}}">
- <div class="pull-left">
- <h1><span class="color-primary">{{underscoreToSpace article.groupTitle}}</span>{{#if article.title}} <span class="text-muted">|</span> {{article.title}}{{/if}}</h1>
- </div>
- {{#if template.withCompare}}
- <div class="pull-right">
- <div class="btn-group">
- <button class="version btn btn-default dropdown-toggle" data-toggle="dropdown">
- <strong>{{article.version}}</strong> <span class="caret"></span>
- </button>
- <ul class="versions dropdown-menu open-left">
- <li class="disabled"><a href="#">{{__ "compare changes to:"}}</a></li>
- {{#each versions}}
- <li class="version"><a href="#">{{this}}</a></li>
- {{/each}}
- </ul>
- </div>
- </div>
- {{/if}}
- <div class="clearfix"></div>
- {{#if article.author}}<h4 class="muted">Authored by: {{article.author}}</h4>{{/if}}
- {{#if article.deprecated}}
- <p class="deprecated"><span>{{__ "DEPRECATED"}}</span>
- {{{markdown article.deprecated.content}}}
- </p>
- {{/if}}
- {{#if article.description}}
- <p>{{{nl2br article.description}}}</p>
- {{/if}}
- <pre
- data-type="{{toLowerCase article.type}}"
- data-prismjs-copy='{{__ "Copy"}}'
- data-prismjs-copy-error='{{__ "Press Ctrl+C to copy"}}'
- data-prismjs-copy-success='{{__ "copied!"}}'
- ><span class="method meth-{{toLowerCase article.type}}">{{article.type}}</span><code class="language-http">{{article.url}}</code></pre>
- {{#if article.permission}}
- <p>
- {{__ "Permission:"}}
- {{#each article.permission}}
- {{name}}
- {{#if title}}
- <button type="button" class="btn btn-info btn-xs" data-title="{{title}}" data-content="{{nl2br description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover">
- <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
- </button>
- {{/if}}
- {{/each}}
- </p>
- {{/if}}
- <!--
- {{!-- CODE EXAMPLES IN TABS --}}
- {{#ifCond article.examples.length '>' 0}}
- <ul class="nav nav-tabs nav-tabs-examples" role="tablist">
- {{#each article.examples}}
- <li {{#ifCond @index
- '==' 0}} class="active"{{/ifCond}} >
- <a href="#examples-{{../id}}-{{@index}}" role="tab" data-toggle="tab">{{title}}</a>
- </li>
- {{/each}}
- </ul>
- <div class="tab-content">
- {{#each article.examples}}
- <div class="tab-pane{{#ifCond @index '==' 0}} active{{/ifCond}}" id="examples-{{../id}}-{{@index}}">
- <pre
- data-type="{{type}}"
- data-prismjs-copy='{{__ "Copy"}}'
- data-prismjs-copy-error='{{__ "Press Ctrl+C to copy"}}'
- data-prismjs-copy-success='{{__ "copied!"}}'
- ><code class="language-{{type}}">{{content}}</code></pre>
- </div>
- {{/each}}
- </div>
- {{/ifCond}}
- -->
- <div class="tabs-container">
- <div class="tabs-header">
- <div class="tab-item active" data-tab="tab-1">参数</div>
- <div class="tab-item" data-tab="tab-2">返回参数</div>
- <div class="tab-item" data-tab="tab-3">测试</div>
- {{#ifCond article.examples.length '>' 0}}
- <div class="tab-item" data-tab="tab-4">示例代码</div>
- {{/ifCond}}
- </div>
- <div class="layui-params tabs-content tab-1 active">
- <div class="tab-content">
- <div class="layui-header">
- {{subTemplate "article-param-block" params=article.header _hasType=_hasTypeInHeaderFields section="header"}}
- </div>
- <div class="layui-parameter">
- {{subTemplate "article-param-block" params=article.parameter _hasType=_hasTypeInParameterFields section="parameter"}}
- </div>
- <div class="layui-query">
- {{subTemplate "article-query-block" params=article.query _hasType=_hasTypeInParameterFields section="query"}}
- </div>
- <div class="layui-body">
- {{subTemplate "article-body-block" params=article.body _hasType=_hasTypeInParameterFields section="body"}}
- </div>
- </div>
- </div>
- <div class="layui-result tabs-content tab-2">
- <div class="tab-content">
- <div class="layui-success">
- {{subTemplate "article-param-block" params=article.success _hasType=_hasTypeInSuccessFields section="success"}}
- </div>
- <div class="layui-error">
- {{subTemplate "article-param-block" params=article.error _col1="Name" _hasType=_hasTypeInErrorFields section="error"}}
- </div>
- </div>
- </div>
- <div class="layui-request tabs-content tab-3">
- <div class="tab-content">
- {{subTemplate "article-sample-request" article=article id=id}}
- </div>
- </div>
- {{#ifCond article.examples.length '>' 0}}
- <div class="layui-request tabs-content tab-4">
- <div class="tab-content">
- <ul class="nav nav-tabs nav-tabs-examples" role="tablist">
- {{#each article.examples}}
- <li class="{{#ifCond @index '==' 0}}active{{/ifCond}}"><a href="#layui-examples-{{../id}}-{{@index}}" role="tab" data-toggle="tab">{{title}}</a></li>
- {{/each}}
- </ul>
- <div class="tab-content" style="padding: 12px 5px;">
- {{#each article.examples}}
- <div class="tab-pane{{#ifCond @index '==' 0}} active{{/ifCond}}" id="layui-examples-{{../id}}-{{@index}}">
- <pre
- data-type="{{type}}"
- data-prismjs-copy='{{__ "Copy"}}'
- data-prismjs-copy-error='{{__ "Press Ctrl+C to copy"}}'
- data-prismjs-copy-success='{{__ "copied!"}}'
- ><code class="language-{{type}}">{{content}}</code></pre>
- </div>
- {{/each}}
- </div>
- </div>
- </div>
- {{/ifCond}}
- </div>
- </article>
- </script>
- <script id="template-article-query-block" type="text/x-handlebars-template">
- {{#if article.query}}
- <h2>{{__ "Query Parameter(s)"}}</h2>
- <table>
- <thead>
- <tr>
- <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th>
- {{#unless this.Type compare=null}}
- <th style="width: 10%">{{__ "Type"}}</th>
- {{/unless}}
- {{#if ../_hasType}}
- <th style="width:60%">{{__ "Description"}}</th>
- {{else}}
- <th style="width:70%">{{__ "Description"}}</th>
- {{/if}}
- </tr>
- </thead>
- <tbody>
- {{#each params}}
- <tr>
- <td class="code">
- {{{nestObject this}}}
- {{#if this.optional}}
- <span class="label optional">{{__ "optional"}}</span>
- {{else}}
- {{#if ../template.showRequiredLabels}}
- <span class="label required">{{__ "required"}}</span>
- {{/if}}
- {{/if}}
- </td>
- {{#unless this.Type compare=null}}
- <td class="code">{{this.type}}</td>
- {{/unless}}
- <td>{{{nl2br this.description}}}
- {{#if defaultValue}}<p class="default-value">{{__ "Default value:"}} <code>{{{defaultValue}}}</code></p>{{/if}}
- {{#if size}}<p class="type-size">{{__ "Size range:"}} <code>{{{size}}}</code></p>{{/if}}
- {{#if allowedValues}}<p class="type-size">{{__ "Allowed values:"}}
- {{#each allowedValues}}
- <code>{{{this}}}</code>{{#unless @last}}, {{/unless}}
- {{/each}}
- </p>
- {{/if}}
- </td>
- </tr>
- {{/each}}
- </tbody>
- </table>
- {{/if}}
- </script>
- <script id="template-article-body-block" type="text/x-handlebars-template">
- {{#if article.body}}
- <h2>{{__ "Request Body"}}</h2>
- <table>
- <thead>
- <tr>
- <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th>
- {{#unless this.Type compare=null}}
- <th style="width: 10%">{{__ "Type"}}</th>
- {{/unless}}
- {{#if ../_hasType}}
- <th style="width: 60%">{{__ "Description"}}</th>
- {{else}}
- <th style="width: 70%">{{__ "Description"}}</th>
- {{/if}}
- </tr>
- </thead>
- <tbody>
- {{#each params}}
- <tr>
- <td class="code">
- {{{nestObject this}}}
- {{#if this.optional}}
- <span class="label optional">{{__ "optional"}}</span>
- {{else}}
- {{#if ../template.showRequiredLabels}}
- <span class="label required">{{__ "required"}}</span>
- {{/if}}
- {{/if}}
- </td>
- {{#unless this.Type compare=null}}
- <td class="code">{{this.type}}</td>
- {{/unless}}
- <td>
- {{{nl2br this.description}}}
- {{#if defaultValue}}
- <p class="default-value">{{__ "Default value:"}} <code>{{{defaultValue}}}</code></p>
- {{/if}}
- {{#if size}}
- <p class="type-size">{{__ "Size range:"}} <code>{{{size}}}</code></p>
- {{/if}}
- {{#if allowedValues}}
- <p class="type-size">{{__ "Allowed values:"}}
- {{#each allowedValues}}
- <code>{{{this}}}</code>{{#unless @last}}, {{/unless}}
- {{/each}}
- </p>
- {{/if}}
- </td>
- </tr>
- {{/each}}
- </tbody>
- </table>
- {{/if}}
- </script>
- <script id="template-article-param-block" type="text/x-handlebars-template">
- {{#if params}}
- {{#each params.fields}}
- <h4>{{__ @key}}</h4>
- <table>
- <thead>
- <tr>
- <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th>
- {{#if ../_hasType}}
- <th style="width: 10%">{{__ "Type"}}</th>
- {{/if}}
- {{#if ../_hasType}}
- <th style="width:60%">{{__ "Description"}}</th>
- {{else}}
- <th style="width:70%">{{__ "Description"}}</th>
- {{/if}}
- </tr>
- </thead>
- <tbody>
- {{#each this}}
- <tr>
- <td class="code">
- {{{nestObject this}}}
- {{#if optional}}
- <span class="label optional">{{__ "optional"}}</span>
- {{else}}
- {{#if ../../template.showRequiredLabels}}
- <span class="label required">{{__ "required"}}</span>
- {{/if}}
- {{/if}}
- </td>
- {{#if ../../_hasType}}
- <td class="code">
- {{{type}}}
- </td>
- {{/if}}
- <td>
- {{{nl2br description}}}
- {{#if defaultValue}}<p class="default-value">{{__ "Default value:"}} <code>{{{defaultValue}}}</code></p>{{/if}}
- {{#if size}}<p class="type-size">{{__ "Size range:"}} <code>{{{size}}}</code></p>{{/if}}
- {{#if allowedValues}}<p class="type-size">{{__ "Allowed values:"}}
- {{#each allowedValues}}
- <code>{{{this}}}</code>{{#unless @last}}, {{/unless}}
- {{/each}}
- </p>
- {{/if}}
- </td>
- </tr>
- {{/each}}
- </tbody>
- </table>
- {{/each}}
- {{#ifCond params.examples.length '>' 0}}
- <ul class="nav nav-tabs nav-tabs-examples" role="tablist">
- {{#each params.examples}}
- <li class="{{#ifCond @index '==' 0}}active{{/ifCond}}">
- <a href="#{{../section}}-examples-{{../id}}-{{@index}}" role="tab" data-toggle="tab">{{title}}</a>
- </li>
- {{/each}}
- </ul>
- <div class="tab-content">
- {{#each params.examples}}
- <div class="tab-pane{{#ifCond @index '==' 0}} active{{/ifCond}}" id="{{../section}}-examples-{{../id}}-{{@index}}">
- <pre
- data-type="{{type}}"
- data-prismjs-copy='{{__ "Copy"}}'
- data-prismjs-copy-error='{{__ "Press Ctrl+C to copy"}}'
- data-prismjs-copy-success='{{__ "copied!"}}'
- ><code class="language-{{type}}">{{reformat content type}}</code></pre>
- </div>
- {{/each}}
- </div>
- {{/ifCond}}
- {{/if}}
- </script>
- <script id="template-article-sample-request" type="text/x-handlebars-template">
- {{#if article.sampleRequest}}
- <div class="well">
- <!-- <h5>{{__ "Send a Sample Request"}}</h5>-->
- <form class="form-horizontal">
- <fieldset>
- <div class="form-group">
- <label class="col-md-3 control-label" for="{{../id}}-sample-request-url">URL</label>
- <div class="input-group">
- <span class="input-group-addon">{{__ "url"}}</span>
- <input id="{{../id}}-sample-request-url" type="url" class="form-control sample-request-url" value="{{article.sampleRequest.0.url}}"/>
- </div>
- </div>
- {{#if article.header}}
- {{#if article.header.fields}}
- <h5>{{__ "Headers"}}</h5>
- {{#each article.header.fields}}
- <div class="{{../id}}-sample-request-header-fields">
- {{#each this}}
- <div class="form-group">
- <label class="col-md-3 control-label" for="sample-request-header-field-{{field}}">{{field}}</label>
- <div class="input-group">
- <span class="input-group-addon">{{{type}}}</span>
- <input type="text" id="sample-request-header-field-{{field}}"
- class="form-control sample-request-input"
- value="{{#if defaultValue}}{{ defaultValue }}{{/if}}"
- placeholder="{{#if defaultValue}}{{ defaultValue }}{{else}}{{field}}{{/if}}"
- data-family="header"
- autocomplete="off"
- data-name="{{field}}"
- data-group="{{@../index}}">
- </div>
- </div>
- {{/each}}
- </div>
- {{/each}}
- {{/if}}
- {{/if}}
- {{#if article.parameter}}
- {{#if article.parameter.fields}}
- <h5>{{__ "Parameters"}}</h5>
- {{#each article.parameter.fields}}
- <div style="width: 100%;display: none;" class="col-md-3">
- <select name="{{../id}}-sample-header-content-type" class="{{../id}}-sample-request-param-select sample-header-content-type sample-header-content-type-switch">
- <option value="auto" selected>ajax-auto</option>
- <option value="json">json</option>
- <option value="form-data">form-data</option>
- </select>
- </div>
- <div class="{{../id}}-sample-request-param-body {{../id}}-sample-header-content-type-body hide">
- <div class="form-group">
- <div class="input-group">
- <div class="input-group-addon">json</div>
- {{#if optional}}
- <textarea id="sample-request-body-json" class="form-control sample-request-body" data-sample-request-body-group="sample-request-param-{{@./index}}" rows="6" style="OVERFLOW: visible" data-sample-request-param-optional="true"></textarea>
- {{else}}
- <textarea id="sample-request-body-json" class="form-control sample-request-body" data-sample-request-body-group="sample-request-param-{{@./index}}" rows="6" style="OVERFLOW: visible"></textarea>
- {{/if}}
- </div>
- </div>
- </div>
- <div class="{{../id}}-sample-request-param-fields {{../id}}-sample-header-content-type-fields">
- {{#each this}}
- <div class="form-group">
- {{#ifNotObject type}}
- <label class="col-md-3 control-label" for="sample-request-param-field-{{field}}">{{field}}</label>
- <div class="input-group">
- <div class="input-group-addon">{{{type}}}</div>
- {{#if allowedValues}}
- <div class="input-group-addon sample-request-select">
- {{#if optional}}
- <select class="form-control" data-name="{{dot2bracket this}}" data-family="query" data-group="{{@../index}}" data-optional="true">
- <option value="" class="empty"><{{__ "No value"}}></option>
- {{#each allowedValues}}
- {{#ifCond ../defaultValue '===' this}}
- <option selected value="{{{removeDblQuotes this}}}">{{{removeDblQuotes this}}}</option>
- {{else}}
- <option value="{{{removeDblQuotes this}}}">{{{removeDblQuotes this}}}</option>
- {{/ifCond}}
- {{/each}}
- </select>
- {{else}}
- <select class="form-control" data-name="{{dot2bracket this}}" data-family="query" data-group="{{@../index}}">
- <option value="" class="empty"><{{__ "No value"}}></option>
- {{#each allowedValues}}
- {{#ifCond ../defaultValue '===' this}}
- <option selected value="{{{removeDblQuotes this}}}">{{{removeDblQuotes this}}}</option>
- {{else}}
- <option value="{{{removeDblQuotes this}}}">{{{removeDblQuotes this}}}</option>
- {{/ifCond}}
- {{/each}}
- </select>
- {{/if}}
- </div>
- <input class="invisible">
- {{else}}
- <div class="sample-request-input-{{type}}-container">
- <div>
- {{#if optional}}
- <input
- type="text"
- id="sample-request-param-field-{{field}}"
- class="{{#ifCond type '!==' 'Boolean'}}form-control{{/ifCond}} sample-request-param"
- value="{{#if defaultValue}}{{ defaultValue }}{{/if}}"
- placeholder="{{#if defaultValue}}{{ defaultValue }}{{/if}}"
- data-name="{{dot2bracket this}}"
- data-family="query"
- data-type="{{setInputType type}}"
- data-group="{{@../index}}"
- data-optional="true">
- {{else}}
- <input
- type="text"
- id="sample-request-param-field-{{field}}"
- class="{{#ifCond type '!==' 'Boolean'}}form-control{{/ifCond}} sample-request-param"
- value="{{#if defaultValue}}{{ defaultValue }}{{/if}}"
- placeholder="{{#if defaultValue}}{{ defaultValue }}{{/if}}"
- data-name="{{dot2bracket this}}"
- data-family="query"
- data-type="{{setInputType type}}"
- data-group="{{@../index}}">
- {{/if}}
- </div>
- </div>
- {{/if}}
- </div>
- {{/ifNotObject}}
- </div>
- {{/each}}
- </div>
- {{/each}}
- {{/if}}
- {{/if}}
- {{#if article.query}}
- <h3>{{__ "Query Parameters"}}</h3>
- <div class="{{../id}}-sample-request-param-fields {{../id}}-sample-header-content-type-fields">
- {{#each article.query}}
- <div class="form-group">
- {{#ifNotObject type}}
- <label class="col-md-3 control-label" for="sample-request-param-field-{{field}}">{{field}}{{#if optional}} ({{__ "optional"}}){{/if}}</label>
- <div class="input-group col-md-6">
- <div class="input-group-addon">{{{type}}}</div>
- {{#if allowedValues}}
- <div class="input-group-addon sample-request-select">
- {{#if optional}}
- <select class="form-control" data-name="{{dot2bracket this}}" data-family="query" data-group="{{@../index}}" data-optional="true">
- <option value="" class="empty"><{{__ "No value"}}></option>
- {{#each allowedValues}}
- {{#ifCond ../defaultValue '===' this}}
- <option selected value="{{{removeDblQuotes this}}}">{{{removeDblQuotes this}}}</option>
- {{else}}
- <option value="{{{removeDblQuotes this}}}">{{{removeDblQuotes this}}}</option>
- {{/ifCond}}
- {{/each}}
- </select>
- {{else}}
- <select class="form-control" data-name="{{dot2bracket this}}" data-family="query" data-group="{{@../index}}">
- <option value="" class="empty"><{{__ "No value"}}></option>
- {{#each allowedValues}}
- {{#ifCond ../defaultValue '===' this}}
- <option selected value="{{{removeDblQuotes this}}}">{{{removeDblQuotes this}}}</option>
- {{else}}
- <option value="{{{removeDblQuotes this}}}">{{{removeDblQuotes this}}}</option>
- {{/ifCond}}
- {{/each}}
- </select>
- {{/if}}
- </div>
- <input class="invisible">
- {{else}}
- <div class="sample-request-input-{{type}}-container">
- <div>
- {{#if optional}}
- <input id="sample-request-param-field-{{field}}"
- class="{{#ifCond type '!==' 'Boolean'}}form-control{{/ifCond}} sample-request-input"
- type="text"
- value="{{#if defaultValue}}{{ defaultValue }}{{/if}}"
- placeholder="{{#if defaultValue}}{{ defaultValue }}{{/if}}"
- data-name="{{dot2bracket this}}"
- data-family="query"
- data-group="{{@../index}}"
- data-optional="true">
- {{else}}
- <input
- type="text"
- id="sample-request-param-field-{{field}}"
- class="{{#ifCond type '!==' 'Boolean'}}form-control{{/ifCond}} sample-request-input"
- value="{{#if defaultValue}}{{ defaultValue }}{{/if}}"
- placeholder="{{#if defaultValue}}{{ defaultValue }}{{/if}}"
- data-name="{{dot2bracket this}}"
- data-family="query"
- data-group="{{@../index}}">
- {{/if}}
- </div>
- </div>
- {{/if}}
- </div>
- {{/ifNotObject}}
- </div>
- {{/each}}
- </div>
- {{/if}}
- {{#if article.body}}
- <h3>{{__ "Body"}}</h3>
- <div class="col-md-3">
- <label for="body-content-type-{{this.id}}">{{__ "Content-Type"}}</label>
- <select id="body-content-type-{{this.id}}" data-id="{{this.id}}" class="sample-request-content-type-switch form-control">
- <option value="body-json" selected>json</option>
- <option value="body-form-data">form-data</option>
- </select>
- </div>
- <div class="col-md-9" id="sample-request-body-json-input-{{this.id}}">
- <div class="form-group">
- <div class="input-group">
- <div class="input-group-addon">json</div>
- {{#if optional}}
- <textarea
- class="form-control sample-request-input"
- rows="6"
- data-family="body-json"
- data-name={{"body"}}
- data-content-type="json"
- data-optional="true"
- >{{body2json article.body}}</textarea>
- {{else}}
- <textarea
- class="form-control sample-request-input"
- rows="6"
- data-family="body-json"
- data-name={{"body"}}
- data-content-type="json"
- >{{body2json article.body}}</textarea>
- {{/if}}
- </div>
- </div>
- </div>
- <div hidden class="col-md-9" id="sample-request-body-form-input-{{this.id}}">
- {{#each article.body}}
- <div class="form-group">
- {{#ifNotObject type}}
- <label class="col-md-3 control-label" for="sample-request-param-field-{{field}}">{{field}}</label>
- <div class="input-group">
- <div class="input-group-addon">{{{type}}}</div>
- {{#if allowedValues}}
- <div class="input-group-addon sample-request-select">
- {{#if optional}}
- <select class="form-control" data-name="{{dot2bracket this}}" data-family="body" data-group="{{@../index}}" data-optional="true">
- <option value="" class="empty"><{{__ "No value"}}></option>
- {{#each allowedValues}}
- {{#ifCond ../defaultValue '===' this}}
- <option selected value="{{{removeDblQuotes this}}}">{{{removeDblQuotes this}}}</option>
- {{else}}
- <option value="{{{removeDblQuotes this}}}">{{{removeDblQuotes this}}}</option>
- {{/ifCond}}
- {{/each}}
- </select>
- {{else}}
- <select class="form-control" data-name="{{dot2bracket this}}" data-family="body" data-group="{{@../index}}">
- <option value="" class="empty"><{{__ "No value"}}></option>
- {{#each allowedValues}}
- {{#ifCond ../defaultValue '===' this}}
- <option selected value="{{{removeDblQuotes this}}}">{{{removeDblQuotes this}}}</option>
- {{else}}
- <option value="{{{removeDblQuotes this}}}">{{{removeDblQuotes this}}}</option>
- {{/ifCond}}
- {{/each}}
- </select>
- {{/if}}
- </div>
- <input class="invisible">
- {{else}}
- <div class="sample-request-input-{{type}}-container">
- <div>
- {{#if checked}}
- {{#if optional}}
- <input id="sample-request-param-field-{{field}}"
- class="{{#ifCond type '!==' 'Boolean'}}form-control{{/ifCond}} sample-request-input"
- type="text"
- value="{{#ifCond type '!==' 'Boolean'}}{{#if defaultValue}}{{ defaultValue }}{{/if}}{{/ifCond}}"
- placeholder="{{#if defaultValue}}{{ defaultValue }}{{/if}}"
- data-family="body"
- data-name="{{dot2bracket this}}"
- data-content-type="form"
- checked
- data-optional="true">
- {{else}}
- <input id="sample-request-param-field-{{field}}"
- class="{{#ifCond type '!==' 'Boolean'}}form-control{{/ifCond}} sample-request-input"
- type="text"
- value="{{#ifCond type '!==' 'Boolean'}}{{#if defaultValue}}{{ defaultValue }}{{/if}}{{/ifCond}}"
- placeholder="{{#if defaultValue}}{{ defaultValue }}{{/if}}"
- data-family="body"
- data-name="{{dot2bracket this}}"
- checked
- data-content-type="form"/>
- {{/if}}
- {{else}}
- {{#if optional}}
- <input id="sample-request-param-field-{{field}}"
- class="{{#ifCond type '!==' 'Boolean'}}form-control{{/ifCond}} sample-request-input"
- type="text"
- value="{{#ifCond type '!==' 'Boolean'}}{{#if defaultValue}}{{ defaultValue }}{{/if}}{{/ifCond}}"
- placeholder="{{#if defaultValue}}{{ defaultValue }}{{/if}}"
- data-family="body"
- data-name="{{dot2bracket this}}"
- data-content-type="form"
- data-optional="true"/>
- {{else}}
- <input id="sample-request-param-field-{{field}}"
- class="{{#ifCond type '!==' 'Boolean'}}form-control{{/ifCond}} sample-request-input"
- type="text"
- value="{{#ifCond type '!==' 'Boolean'}}{{#if defaultValue}}{{ defaultValue }}{{/if}}{{/ifCond}}"
- placeholder="{{#if defaultValue}}{{ defaultValue }}{{/if}}"
- data-family="body"
- data-name="{{dot2bracket this}}"
- data-content-type="form"/>
- {{/if}}
- {{/if}}
- </div>
- </div>
- {{/if}}
- </div>
- {{/ifNotObject}}
- </div>
- {{/each}}
- </div>
- {{/if}}
- <div class="form-group">
- <div class="controls pull-right">
- <button class="btn btn-primary bg-primary sample-request-send" data-type="{{article.type}}">{{__ "Send"}}</button>
- <button class="btn btn-danger bg-red sample-request-clear" data-type="{{article.type}}">{{__ "Reset"}}</button>
- </div>
- </div>
- <div class="form-group sample-request-response" hidden>
- <h3>
- {{__ "Response"}}
- <button class="btn btn-default btn-xs pull-right sample-request-clear">X</button>
- </h3>
- <pre
- data-type="json"
- data-prismjs-copy='{{__ "Copy"}}'
- data-prismjs-copy-error='{{__ "Press Ctrl+C to copy"}}'
- data-prismjs-copy-success='{{__ "copied!"}}'
- ><code class="language-json sample-request-response-json"></code></pre>
- </div>
- </fieldset>
- </form>
- </div>
- {{/if}}
- </script>
- <script id="template-compare-article" type="text/x-handlebars-template">
- <article id="api-{{article.group}}-{{article.name}}-{{article.version}}" class="{{#if hidden}}hide{{/if}}" data-group="{{article.group}}" data-name="{{article.name}}" data-version="{{article.version}}" data-compare-version="{{compare.version}}">
- <div class="pull-left">
- <h1>{{underscoreToSpace article.groupTitle}} | {{{showDiff article.title compare.title}}}</h1>
- </div>
- <div class="pull-right">
- <div class="btn-group">
- <button class="btn btn-success" disabled>
- <strong>{{article.version}}</strong> {{__ "compared to"}}
- </button>
- <button class="version btn btn-danger dropdown-toggle" data-toggle="dropdown">
- <strong>{{compare.version}}</strong> <span class="caret"></span>
- </button>
- <ul class="versions dropdown-menu open-left">
- <li class="disabled"><a href="#">{{__ "compare changes to:"}}</a></li>
- <li class="divider"></li>
- {{#each versions}}
- <li class="version"><a href="#">{{this}}</a></li>
- {{/each}}
- </ul>
- </div>
- </div>
- <div class="clearfix"></div>
- {{#if article.description}}
- <p>{{{showDiff article.description compare.description "nl2br"}}}</p>
- {{else}}
- {{#if compare.description}}
- <p>{{{showDiff "" compare.description "nl2br"}}}</p>
- {{/if}}
- {{/if}}
- <span class="method meth-{{toLowerCase compare.type}}">{{compare.type}}</span>
- <pre
- data-type="{{toLowerCase article.type}}"
- data-prismjs-copy='{{__ "Copy"}}'
- data-prismjs-copy-error='{{__ "Press Ctrl+C to copy"}}'
- data-prismjs-copy-success='{{__ "copied!"}}'
- class="language-html"
- >{{{showDiff article.url compare.url}}}</pre>
- {{subTemplate "article-compare-permission" article=article compare=compare}}
- <ul class="nav nav-tabs nav-tabs-examples" role="tablist">
- {{#each_compare_title article.examples compare.examples}}
- {{#if typeSame}}
- <li class="{{#ifCond index '==' 0}}active{{/ifCond}}">
- <a href="#compare-examples-{{../article.id}}-{{index}}" role="tab" data-toggle="tab">{{{showDiff source.title compare.title}}}</a>
- </li>
- {{/if}}
- {{#if typeIns}}
- <li class="{{#ifCond index '==' 0}}active{{/ifCond}}">
- <a href="#compare-examples-{{../article.id}}-{{index}}">
- <ins>{{{source.title}}}</ins>
- </a>
- </li>
- {{/if}}
- {{#if typeDel}}
- <li class="{{#ifCond index '==' 0}}active{{/ifCond}}">
- <a href="#compare-examples-{{../article.id}}-{{index}}">
- <del>{{{compare.title}}}</del>
- </a>
- </li>
- {{/if}}
- {{/each_compare_title}}
- </ul>
- <div class="tab-content">
- {{#each_compare_title article.examples compare.examples}}
- {{#if typeSame}}
- <div class="tab-pane{{#ifCond index '==' 0}} active{{/ifCond}}" id="compare-examples-{{../article.id}}-{{index}}">
- <pre
- data-type="{{source.type}}"
- data-prismjs-copy='{{__ "Copy"}}'
- data-prismjs-copy-error='{{__ "Press Ctrl+C to copy"}}'
- data-prismjs-copy-success='{{__ "copied!"}}'
- ><code class="language-diff-{{source.type}} diff-highlight">{{{showDiff source.content compare.content "code"}}}</code></pre>
- </div>
- {{/if}}
- {{#if typeIns}}
- <div class="tab-pane{{#ifCond index '==' 0}} active{{/ifCond}}" id="compare-examples-{{../article.id}}-{{index}}">
- <pre
- data-type="{{source.type}}"
- data-prismjs-copy='{{__ "Copy"}}'
- data-prismjs-copy-error='{{__ "Press Ctrl+C to copy"}}'
- data-prismjs-copy-success='{{__ "copied!"}}'
- ><code class="language-{{source.type}}">{{{source.content}}}</code></pre>
- </div>
- {{/if}}
- {{#if typeDel}}
- <div class="tab-pane{{#ifCond index '==' 0}} active{{/ifCond}}" id="compare-examples-{{../article.id}}-{{index}}">
- <pre
- data-type="{{compare.type}}"
- data-prismjs-copy='{{__ "Copy"}}'
- data-prismjs-copy-error='{{__ "Press Ctrl+C to copy"}}'
- data-prismjs-copy-success='{{__ "copied!"}}'
- ><code class="language-{{source.type}}">{{{compare.content}}}</code></pre>
- </div>
- {{/if}}
- {{/each_compare_title}}
- </div>
- <div class="layui-header">
- {{subTemplate "article-compare-param-block" source=article.header compare=compare.header _hasType=_hasTypeInHeaderFields section="header"}}
- </div>
- <div class="layui-parameter">
- {{subTemplate "article-compare-param-block" source=article.parameter compare=compare.parameter _hasType=_hasTypeInParameterFields section="parameter"}}
- </div>
- <div class="layui-parameter">
- {{subTemplate "article-compare-query-block" source=article.query compare=compare.query _hasType=_hasTypeInParameterFields section="query"}}
- </div>
- <div class="layui-body">
- {{subTemplate "article-compare-body-block" source=article.body compare=compare.body _hasType=_hasTypeInParameterFields section="body"}}
- </div>
- <div class="layui-success">
- {{subTemplate "article-compare-param-block" source=article.success compare=compare.success _hasType=_hasTypeInSuccessFields section="success"}}
- </div>
- <div class="layui-error">
- {{subTemplate "article-compare-param-block" source=article.error compare=compare.error _col1="Name" _hasType=_hasTypeInErrorFields section="error"}}
- </div>
- {{subTemplate "article-sample-request" article=article id=id}}
- </article>
- </script>
- <script id="template-article-compare-permission" type="text/x-handlebars-template">
- <p>
- {{__ "Permission:"}}
- {{#each_compare_list_field article.permission compare.permission field="name"}}
- {{#if source}}
- {{#if typeSame}}
- {{source.name}}
- {{#if source.title}}
- <button type="button" class="btn btn-info btn-xs" data-title="{{source.title}}" data-content="{{nl2br source.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover">
- <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
- </button>
- {{#unless _last}}, {{/unless}}
- {{/if}}
- {{/if}}
- {{#if typeIns}}
- <ins>{{source.name}}</ins>
- {{#if source.title}}
- <button type="button" class="btn btn-info btn-xs" data-title="{{source.title}}" data-content="{{nl2br source.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover">
- <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
- </button>
- {{#unless _last}}, {{/unless}}
- {{/if}}
- {{/if}}
- {{#if typeDel}}
- <del>{{source.name}}</del>
- {{#if source.title}}
- <button type="button" class="btn btn-info btn-xs" data-title="{{source.title}}" data-content="{{nl2br source.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover">
- <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
- </button>
- {{#unless _last}}, {{/unless}}
- {{/if}}
- {{/if}}
- {{else}}
- {{#if typeSame}}
- {{compare.name}}
- {{#if compare.title}}
- <button type="button" class="btn btn-info btn-xs" data-title="{{compare.title}}" data-content="{{nl2br compare.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover">
- <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
- </button>
- {{#unless _last}}, {{/unless}}
- {{/if}}
- {{/if}}
- {{#if typeIns}}
- <ins>{{compare.name}}</ins>
- {{#if compare.title}}
- <button type="button" class="btn btn-info btn-xs" data-title="{{compare.title}}" data-content="{{nl2br compare.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover">
- <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
- </button>
- {{#unless _last}}, {{/unless}}
- {{/if}}
- {{/if}}
- {{#if typeDel}}
- <del>{{compare.name}}</del>
- {{#if compare.title}}
- <button type="button" class="btn btn-info btn-xs" data-title="{{compare.title}}" data-content="{{nl2br compare.description}}" data-html="true" data-toggle="popover" data-placement="right" data-trigger="hover">
- <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
- </button>
- {{#unless _last}}, {{/unless}}
- {{/if}}
- {{/if}}
- {{/if}}
- {{/each_compare_list_field}}
- </p>
- </script>
- <script id="template-article-compare-param-block" type="text/x-handlebars-template">
- {{#if source}}
- {{#each_compare_keys source.fields compare.fields}}
- {{#if typeSame}}
- <h2>{{__ source.key}}</h2>
- <table>
- <thead>
- <tr>
- <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th>
- {{#if ../_hasType}}
- <th style="width: 10%">{{__ "Type"}}</th>
- {{/if}}
- {{#if ../_hasType}}
- <th style="width: 60%">{{__ "Description"}}</th>
- {{else}}
- <th style="width: 70%">{{__ "Description"}}</th>
- {{/if}}
- </tr>
- </thead>
- {{subTemplate "article-compare-param-block-body" source=source.value compare=compare.value _hasType=../_hasType}}
- </table>
- {{/if}}
- {{#if typeIns}}
- <h2>
- <ins>{{__ source.key}}</ins>
- </h2>
- <table class="ins">
- <thead>
- <tr>
- <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th>
- {{#if ../_hasType}}
- <th style="width: 10%">{{__ "Type"}}</th>
- {{/if}}
- {{#if ../_hasType}}
- <th style="width: 60%">{{__ "Description"}}</th>
- {{else}}
- <th style="width: 70%">{{__ "Description"}}</th>
- {{/if}}
- </tr>
- </thead>
- {{subTemplate "article-compare-param-block-body" source=source.value compare=source.value _hasType=../_hasType}}
- </table>
- {{/if}}
- {{#if typeDel}}
- <h2>
- <del>{{__ compare.key}}</del>
- </h2>
- <table class="del">
- <thead>
- <tr>
- <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th>
- {{#if ../_hasType}}
- <th style="width: 10%">{{__ "Type"}}</th>
- {{/if}}
- {{#if ../_hasType}}
- <th style="width: 60%">{{__ "Description"}}</th>
- {{else}}
- <th style="width: 70%">{{__ "Description"}}</th>
- {{/if}}
- </tr>
- </thead>
- {{subTemplate "article-compare-param-block-body" source=compare.value compare=compare.value _hasType=../_hasType}}
- </table>
- {{/if}}
- {{/each_compare_keys}}
- {{#if source.examples}}
- <ul class="nav nav-tabs nav-tabs-examples" role="tablist">
- {{#each_compare_title source.examples compare.examples}}
- {{#if typeSame}}
- <li class="{{#ifCond index '==' 0}}active{{/ifCond}}">
- <a href="#{{../section}}-compare-examples-{{../article.id}}-{{index}}" role="tab" data-toggle="tab">{{{showDiff source.title compare.title}}}</a>
- </li>
- {{/if}}
- {{#if typeIns}}
- <li class="{{#ifCond index '==' 0}}active{{/ifCond}}">
- <a href="#{{../section}}-compare-examples-{{../article.id}}-{{index}}">
- <ins>{{{source.title}}}</ins>
- </a>
- </li>
- {{/if}}
- {{#if typeDel}}
- <li class="{{#ifCond index '==' 0}}active{{/ifCond}}">
- <a href="#{{../section}}-compare-examples-{{../article.id}}-{{index}}">
- <del>{{{compare.title}}}</del>
- </a>
- </li>
- {{/if}}
- {{/each_compare_title}}
- </ul>
- <div class="tab-content">
- {{#each_compare_title source.examples compare.examples}}
- {{#if typeSame}}
- <div class="tab-pane{{#ifCond index '==' 0}} active{{/ifCond}}" id="{{../section}}-compare-examples-{{../article.id}}-{{index}}">
- <pre
- data-type="{{source.type}}"
- data-prismjs-copy='{{__ "Copy"}}'
- data-prismjs-copy-error='{{__ "Press Ctrl+C to copy"}}'
- data-prismjs-copy-success='{{__ "copied!"}}'
- ><code class="language-diff-{{source.type}} diff-highlight">{{{showDiff source.content compare.content "code"}}}</code></pre>
- </div>
- {{/if}}
- {{#if typeIns}}
- <div class="tab-pane{{#ifCond index '==' 0}} active{{/ifCond}}" id="{{../section}}-compare-examples-{{../article.id}}-{{index}}">
- <pre
- data-type="{{source.type}}"
- data-prismjs-copy='{{__ "Copy"}}'
- data-prismjs-copy-error='{{__ "Press Ctrl+C to copy"}}'
- data-prismjs-copy-success='{{__ "copied!"}}'
- ><code class="language-{{source.type}}">{{{source.content}}}</code></pre>
- </div>
- {{/if}}
- {{#if typeDel}}
- <div class="tab-pane{{#ifCond index '==' 0}} active{{/ifCond}}" id="{{../section}}-compare-examples-{{../article.id}}-{{index}}">
- <pre
- data-type="{{compare.type}}"
- data-prismjs-copy='{{__ "Copy"}}'
- data-prismjs-copy-error='{{__ "Press Ctrl+C to copy"}}'
- data-prismjs-copy-success='{{__ "copied!"}}'
- ><code class="language-{{source.type}}">{{{compare.content}}}</code></pre>
- </div>
- {{/if}}
- {{/each_compare_title}}
- </div>
- {{/if}}
- {{/if}}
- </script>
- <script id="template-article-compare-query-block" type="text/x-handlebars-template">
- {{#if article.query}}
- <h2>{{__ "Query Parameter(s)"}}</h2>
- <table class="table table-hover">
- <thead>
- <tr>
- <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th>
- {{#unless this.Type compare=null}}
- <th style="width: 10%">{{__ "Type"}}</th>
- {{/unless}}
- {{#if ../_hasType}}
- <th style="width: 60%">{{__ "Description"}}</th>
- {{else}}
- <th style="width: 70%">{{__ "Description"}}</th>
- {{/if}}
- </tr>
- </thead>
- {{subTemplate "article-compare-param-block-body" source=source compare=compare _hasType=this.type}}
- </table>
- {{/if}}
- </script>
- <script id="template-article-compare-body-block" type="text/x-handlebars-template">
- {{#if article.body}}
- <h2>{{__ "Request Body"}}</h2>
- <table class="table table-hover">
- <thead>
- <tr>
- <th style="width: 30%">{{#if ../_col1}}{{__ ../_col1}}{{else}}{{__ "Field"}}{{/if}}</th>
- {{#unless this.Type compare=null}}
- <th style="width: 10%">{{__ "Type"}}</th>
- {{/unless}}
- {{#if ../_hasType}}
- <th style="width: 60%">{{__ "Description"}}</th>
- {{else}}
- <th style="width: 70%">{{__ "Description"}}</th>
- {{/if}}
- </tr>
- </thead>
- {{subTemplate "article-compare-param-block-body" source=source compare=compare _hasType=this.type}}
- </table>
- {{/if}}
- </script>
- <script id="template-article-compare-param-block-body" type="text/x-handlebars-template">
- <tbody>
- {{#each_compare_field source compare}}
- {{#if typeSame}}
- <tr>
- <td class="code">
- {{{nestObject source}}}
- {{#if source.optional}}
- {{#if compare.optional}} <span class="label label-optional">{{__ "optional"}}</span>
- {{else}} <span class="label label-optional label-ins">{{__ "optional"}}</span>
- {{/if}}
- {{else}}
- {{#if compare.optional}} <span class="label label-optional label-del">{{__ "optional"}}</span>{{/if}}
- {{/if}}
- </td>
- {{#if source.type}}
- {{#if compare.type}}
- <td>{{{showDiff source.type compare.type}}}</td>
- {{else}}
- <td>{{{source.type}}}</td>
- {{/if}}
- {{else}}
- {{#if compare.type}}
- <td>{{{compare.type}}}</td>
- {{else}}
- {{#if ../../../../_hasType}}
- <td></td>
- {{/if}}
- {{/if}}
- {{/if}}
- <td>
- {{{showDiff source.description compare.description "nl2br"}}}
- {{#if source.defaultValue}}<p class="default-value">{{__ "Default value:"}} <code>{{{showDiff source.defaultValue compare.defaultValue}}}</code>
- <p>{{/if}}
- </td>
- </tr>
- {{/if}}
- {{#if typeIns}}
- <tr class="ins">
- <td class="code">
- {{{nestObject source}}}
- {{#if source.optional}} <span class="label label-optional label-ins">{{__ "optional"}}</span>{{/if}}
- </td>
- {{#if source.type}}
- <td>{{{source.type}}}</td>
- {{else}}
- {{{typRowTd}}}
- {{/if}}
- <td>
- {{{nl2br source.description}}}
- {{#if source.defaultValue}}<p class="default-value">{{__ "Default value:"}} <code>{{{source.defaultValue}}}</code>
- <p>{{/if}}
- </td>
- </tr>
- {{/if}}
- {{#if typeDel}}
- <tr class="del">
- <td class="code">
- {{{nestObject compare}}}
- {{#if compare.optional}} <span class="label label-optional label-del">{{__ "optional"}}</span>{{/if}}
- </td>
- {{#if compare.type}}
- <td>{{{compare.type}}}</td>
- {{else}}
- {{{typRowTd}}}
- {{/if}}
- <td>
- {{{nl2br compare.description}}}
- {{#if compare.defaultValue}}<p class="default-value">{{__ "Default value:"}} <code>{{{compare.defaultValue}}}</code>
- <p>{{/if}}
- </td>
- </tr>
- {{/if}}
- {{/each_compare_field}}
- </tbody>
- </script>
- <div class="container-fluid">
- <div class="row row-offcanvas row-offcanvas-left">
- <div id="sidenav" class="col-sm-3 col-lg-2"></div>
- <div id="content" class="col-sm-9 col-lg-10">
- <div id="project"></div>
- <div id="header"></div>
- <div id="sections"></div>
- <div id="footer"></div>
- <!-- <div id="generator"></div>-->
- </div>
- </div>
- </div>
- <div id="loader">
- <div class="spinner">
- <div class="spinner-container container1">
- <div class="circle1"></div>
- <div class="circle2"></div>
- <div class="circle3"></div>
- <div class="circle4"></div>
- </div>
- <div class="spinner-container container2">
- <div class="circle1"></div>
- <div class="circle2"></div>
- <div class="circle3"></div>
- <div class="circle4"></div>
- </div>
- <div class="spinner-container container3">
- <div class="circle1"></div>
- <div class="circle2"></div>
- <div class="circle3"></div>
- <div class="circle4"></div>
- </div>
- <p>Loading...</p>
- </div>
- </div>
- <script src="assets/main.bundle.js?v=1751274384094"></script>
- <!--suppress JSJQueryEfficiency, JSStringConcatenationToES6Template, JSStringConcatenationToES6Template, JSStringConcatenationToES6Template -->
- <script>
- /**
- * 请求结束后会执行这个方法
- * @param jsonResponse 请求结果
- */
- function successResponse(jsonResponse)
- {
- let aa = JSON.parse(jsonResponse);
- if(aa.data.token){
- if(aa.data.token.startsWith("Bearer ")){
- $('input[data-name="Authorization"]').val(aa.data.token);
- }else{
- $('input[data-name="Authorization"]').val("Bearer "+aa.data.token);
- }
- }
- if(aa.data.im){
- if(aa.data.im.authToken)
- $('input[data-name="Im-Token"]').val(aa.data.im.authToken);
- }
- }
- function toMenu(group, name) {
- if ($(`.show-group.api-${group}-init`).eq(0).next().hasClass('layui-icon-down')) {
- $(`.api-${group}-init`).eq(0).click();
- }
- $(`.api-${group}-${name}-init`).eq(0).click();
- }
- $(function () {
- $(`.sidenav .is-new`).addClass('ws-hidden');
- $('.nav-header').click(function () {
- let group = $(this).data('group');
- if ($(this).find('i').hasClass('layui-icon-down')) {
- $(this).find('i').removeClass('layui-icon-down').addClass('layui-icon-up');
- $(`.is-new[data-group="${group}"]`).removeClass('ws-hidden');
- } else {
- $(this).find('i').removeClass('layui-icon-up').addClass('layui-icon-down');
- $(`.is-new[data-group="${group}"]`).addClass('ws-hidden');
- }
- });
- // 获取所有选项卡
- const tabItems = document.querySelectorAll('.tab-item');
- const tabContents = document.querySelectorAll('.tabs-content');
- tabItems.forEach(item => {
- item.addEventListener('click', function () {
- // 移除所有选项卡的active类
- tabItems.forEach(i => i.classList.remove('active'));
- tabContents.forEach(content => content.classList.remove('active'));
- // 激活点击的选项卡
- this.classList.add('active');
- let id = $(this).data('tab');
- $(`.${id}`).addClass('active');
- // const activeTabContent = document.querySelector(`.${this.dataset.tab}`);
- // activeTabContent.classList.add('active');
- });
- });
- $('#sections').children('section').hide();
- $('#sections').children('section').children('h1').hide();
- $('#sections').children('section').children('div').hide();
- $('#scrollingNav').children('ul').children('.nav-header').children('a').css('background-color', '#666');
- $('.is-new .show-api').on('click', function () {
- $('#project').hide();
- $('#sections').children('section').hide();
- $('#sections').children('section').children('div').hide();
- $('.is-new').children('a').css('background-color', '').css('color', '');
- // $(this).css('background-color', '#0088cc');
- $(this).css('background-color', '#009688').css('color', '#ffffff');
- let group = $(this).data().group + '-group';
- $(`.${group}`).show();
- let a = this.attributes.href.value;
- $(a).show();
- $('.tab-item').removeClass('active');
- $(a).find('.tab-item').eq(0).addClass('active');
- $('.tabs-content').removeClass('active');
- $(a).find('.tab-1').addClass('active');
- });
- //$('.is-new .show-api').eq(0).click();
- });
- </script>
- </body>
- </html>
|