mirror of
https://gitee.com/bookshelfplus/bookshelfplus
synced 2025-09-01 22:53:29 +08:00
6027 lines
199 KiB
HTML
6027 lines
199 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<meta name="generator" content="Asciidoctor 1.5.6.1">
|
||
<title>书栖网 服务端接口文档</title>
|
||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
|
||
<style>
|
||
/* Asciidoctor default stylesheet | MIT License | http://asciidoctor.org */
|
||
/* Remove comment around @import statement below when using as a custom stylesheet */
|
||
/*@import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";*/
|
||
article,aside,details,figcaption,figure,footer,header,hgroup,main,nav,section,summary{display:block}
|
||
audio,canvas,video{display:inline-block}
|
||
audio:not([controls]){display:none;height:0}
|
||
[hidden],template{display:none}
|
||
script{display:none!important}
|
||
html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}
|
||
a{background:transparent}
|
||
a:focus{outline:thin dotted}
|
||
a:active,a:hover{outline:0}
|
||
h1{font-size:2em;margin:.67em 0}
|
||
abbr[title]{border-bottom:1px dotted}
|
||
b,strong{font-weight:bold}
|
||
dfn{font-style:italic}
|
||
hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}
|
||
mark{background:#ff0;color:#000}
|
||
code,kbd,pre,samp{font-family:monospace;font-size:1em}
|
||
pre{white-space:pre-wrap}
|
||
q{quotes:"\201C" "\201D" "\2018" "\2019"}
|
||
small{font-size:80%}
|
||
sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
|
||
sup{top:-.5em}
|
||
sub{bottom:-.25em}
|
||
img{border:0}
|
||
svg:not(:root){overflow:hidden}
|
||
figure{margin:0}
|
||
fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
|
||
legend{border:0;padding:0}
|
||
button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
|
||
button,input{line-height:normal}
|
||
button,select{text-transform:none}
|
||
button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}
|
||
button[disabled],html input[disabled]{cursor:default}
|
||
input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}
|
||
input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}
|
||
input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}
|
||
button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
|
||
textarea{overflow:auto;vertical-align:top}
|
||
table{border-collapse:collapse;border-spacing:0}
|
||
*,*:before,*:after{-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box}
|
||
html,body{font-size:100%}
|
||
body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;font-weight:400;font-style:normal;line-height:1;position:relative;cursor:auto;tab-size:4;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
|
||
a:hover{cursor:pointer}
|
||
img,object,embed{max-width:100%;height:auto}
|
||
object,embed{height:100%}
|
||
img{-ms-interpolation-mode:bicubic}
|
||
.left{float:left!important}
|
||
.right{float:right!important}
|
||
.text-left{text-align:left!important}
|
||
.text-right{text-align:right!important}
|
||
.text-center{text-align:center!important}
|
||
.text-justify{text-align:justify!important}
|
||
.hide{display:none}
|
||
img,object,svg{display:inline-block;vertical-align:middle}
|
||
textarea{height:auto;min-height:50px}
|
||
select{width:100%}
|
||
.center{margin-left:auto;margin-right:auto}
|
||
.spread{width:100%}
|
||
p.lead,.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{font-size:1.21875em;line-height:1.6}
|
||
.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
|
||
div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0;direction:ltr}
|
||
a{color:#2156a5;text-decoration:underline;line-height:inherit}
|
||
a:hover,a:focus{color:#1d4b8f}
|
||
a img{border:none}
|
||
p{font-family:inherit;font-weight:400;font-size:1em;line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
|
||
p aside{font-size:.875em;line-height:1.35;font-style:italic}
|
||
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
|
||
h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
|
||
h1{font-size:2.125em}
|
||
h2{font-size:1.6875em}
|
||
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
|
||
h4,h5{font-size:1.125em}
|
||
h6{font-size:1em}
|
||
hr{border:solid #ddddd8;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em;height:0}
|
||
em,i{font-style:italic;line-height:inherit}
|
||
strong,b{font-weight:bold;line-height:inherit}
|
||
small{font-size:60%;line-height:inherit}
|
||
code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
|
||
ul,ol,dl{font-size:1em;line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
|
||
ul,ol{margin-left:1.5em}
|
||
ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0;font-size:1em}
|
||
ul.square li ul,ul.circle li ul,ul.disc li ul{list-style:inherit}
|
||
ul.square{list-style-type:square}
|
||
ul.circle{list-style-type:circle}
|
||
ul.disc{list-style-type:disc}
|
||
ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
|
||
dl dt{margin-bottom:.3125em;font-weight:bold}
|
||
dl dd{margin-bottom:1.25em}
|
||
abbr,acronym{text-transform:uppercase;font-size:90%;color:rgba(0,0,0,.8);border-bottom:1px dotted #ddd;cursor:help}
|
||
abbr{text-transform:none}
|
||
blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
|
||
blockquote cite{display:block;font-size:.9375em;color:rgba(0,0,0,.6)}
|
||
blockquote cite:before{content:"\2014 \0020"}
|
||
blockquote cite a,blockquote cite a:visited{color:rgba(0,0,0,.6)}
|
||
blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
|
||
@media only screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
|
||
h1{font-size:2.75em}
|
||
h2{font-size:2.3125em}
|
||
h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
|
||
h4{font-size:1.4375em}}
|
||
table{background:#fff;margin-bottom:1.25em;border:solid 1px #dedede}
|
||
table thead,table tfoot{background:#f7f8f7;font-weight:bold}
|
||
table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
|
||
table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
|
||
table tr.even,table tr.alt,table tr:nth-of-type(even){background:#f8f8f7}
|
||
table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{display:table-cell;line-height:1.6}
|
||
h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
|
||
h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
|
||
.clearfix:before,.clearfix:after,.float-group:before,.float-group:after{content:" ";display:table}
|
||
.clearfix:after,.float-group:after{clear:both}
|
||
*:not(pre)>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background-color:#f7f7f8;-webkit-border-radius:4px;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed;word-wrap:break-word}
|
||
*:not(pre)>code.nobreak{word-wrap:normal}
|
||
*:not(pre)>code.nowrap{white-space:nowrap}
|
||
pre,pre>code{line-height:1.45;color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;text-rendering:optimizeSpeed}
|
||
em em{font-style:normal}
|
||
strong strong{font-weight:400}
|
||
.keyseq{color:rgba(51,51,51,.8)}
|
||
kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background-color:#f7f7f7;border:1px solid #ccc;-webkit-border-radius:3px;border-radius:3px;-webkit-box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em white inset;box-shadow:0 1px 0 rgba(0,0,0,.2),0 0 0 .1em #fff inset;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
|
||
.keyseq kbd:first-child{margin-left:0}
|
||
.keyseq kbd:last-child{margin-right:0}
|
||
.menuseq,.menuref{color:#000}
|
||
.menuseq b:not(.caret),.menuref{font-weight:inherit}
|
||
.menuseq{word-spacing:-.02em}
|
||
.menuseq b.caret{font-size:1.25em;line-height:.8}
|
||
.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
|
||
b.button:before,b.button:after{position:relative;top:-1px;font-weight:400}
|
||
b.button:before{content:"[";padding:0 3px 0 2px}
|
||
b.button:after{content:"]";padding:0 2px 0 3px}
|
||
p a>code:hover{color:rgba(0,0,0,.9)}
|
||
#header,#content,#footnotes,#footer{width:100%;margin-left:auto;margin-right:auto;margin-top:0;margin-bottom:0;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
|
||
#header:before,#header:after,#content:before,#content:after,#footnotes:before,#footnotes:after,#footer:before,#footer:after{content:" ";display:table}
|
||
#header:after,#content:after,#footnotes:after,#footer:after{clear:both}
|
||
#content{margin-top:1.25em}
|
||
#content:before{content:none}
|
||
#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
|
||
#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #ddddd8}
|
||
#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #ddddd8;padding-bottom:8px}
|
||
#header .details{border-bottom:1px solid #ddddd8;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:-ms-flexbox;display:-webkit-flex;display:flex;-ms-flex-flow:row wrap;-webkit-flex-flow:row wrap;flex-flow:row wrap}
|
||
#header .details span:first-child{margin-left:-.125em}
|
||
#header .details span.email a{color:rgba(0,0,0,.85)}
|
||
#header .details br{display:none}
|
||
#header .details br+span:before{content:"\00a0\2013\00a0"}
|
||
#header .details br+span.author:before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
|
||
#header .details br+span#revremark:before{content:"\00a0|\00a0"}
|
||
#header #revnumber{text-transform:capitalize}
|
||
#header #revnumber:after{content:"\00a0"}
|
||
#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #ddddd8;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
|
||
#toc{border-bottom:1px solid #efefed;padding-bottom:.5em}
|
||
#toc>ul{margin-left:.125em}
|
||
#toc ul.sectlevel0>li>a{font-style:italic}
|
||
#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
|
||
#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
|
||
#toc li{line-height:1.3334;margin-top:.3334em}
|
||
#toc a{text-decoration:none}
|
||
#toc a:active{text-decoration:underline}
|
||
#toctitle{color:#7a2518;font-size:1.2em}
|
||
@media only screen and (min-width:768px){#toctitle{font-size:1.375em}
|
||
body.toc2{padding-left:15em;padding-right:0}
|
||
#toc.toc2{margin-top:0!important;background-color:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #efefed;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
|
||
#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
|
||
#toc.toc2>ul{font-size:.9em;margin-bottom:0}
|
||
#toc.toc2 ul ul{margin-left:0;padding-left:1em}
|
||
#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
|
||
body.toc2.toc-right{padding-left:0;padding-right:15em}
|
||
body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #efefed;left:auto;right:0}}
|
||
@media only screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
|
||
#toc.toc2{width:20em}
|
||
#toc.toc2 #toctitle{font-size:1.375em}
|
||
#toc.toc2>ul{font-size:.95em}
|
||
#toc.toc2 ul ul{padding-left:1.25em}
|
||
body.toc2.toc-right{padding-left:0;padding-right:20em}}
|
||
#content #toc{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
|
||
#content #toc>:first-child{margin-top:0}
|
||
#content #toc>:last-child{margin-bottom:0}
|
||
#footer{max-width:100%;background-color:rgba(0,0,0,.8);padding:1.25em}
|
||
#footer-text{color:rgba(255,255,255,.8);line-height:1.44}
|
||
.sect1{padding-bottom:.625em}
|
||
@media only screen and (min-width:768px){.sect1{padding-bottom:1.25em}}
|
||
.sect1+.sect1{border-top:1px solid #efefed}
|
||
#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
|
||
#content h1>a.anchor:before,h2>a.anchor:before,h3>a.anchor:before,#toctitle>a.anchor:before,.sidebarblock>.content>.title>a.anchor:before,h4>a.anchor:before,h5>a.anchor:before,h6>a.anchor:before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
|
||
#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
|
||
#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
|
||
#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
|
||
.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
|
||
.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
|
||
table.tableblock>caption.title{white-space:nowrap;overflow:visible;max-width:0}
|
||
.paragraph.lead>p,#preamble>.sectionbody>.paragraph:first-of-type p{color:rgba(0,0,0,.85)}
|
||
table.tableblock #preamble>.sectionbody>.paragraph:first-of-type p{font-size:inherit}
|
||
.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
|
||
.admonitionblock>table td.icon{text-align:center;width:80px}
|
||
.admonitionblock>table td.icon img{max-width:initial}
|
||
.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
|
||
.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #ddddd8;color:rgba(0,0,0,.6)}
|
||
.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
|
||
.exampleblock>.content{border-style:solid;border-width:1px;border-color:#e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;-webkit-border-radius:4px;border-radius:4px}
|
||
.exampleblock>.content>:first-child{margin-top:0}
|
||
.exampleblock>.content>:last-child{margin-bottom:0}
|
||
.sidebarblock{border-style:solid;border-width:1px;border-color:#e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;-webkit-border-radius:4px;border-radius:4px}
|
||
.sidebarblock>:first-child{margin-top:0}
|
||
.sidebarblock>:last-child{margin-bottom:0}
|
||
.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
|
||
.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
|
||
.literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint{background:#f7f7f8}
|
||
.sidebarblock .literalblock pre,.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint{background:#f2f1f1}
|
||
.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em}
|
||
.literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal}
|
||
@media only screen and (min-width:768px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:.90625em}}
|
||
@media only screen and (min-width:1280px){.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{font-size:1em}}
|
||
.literalblock.output pre{color:#f7f7f8;background-color:rgba(0,0,0,.9)}
|
||
.listingblock pre.highlightjs{padding:0}
|
||
.listingblock pre.highlightjs>code{padding:1em;-webkit-border-radius:4px;border-radius:4px}
|
||
.listingblock pre.prettyprint{border-width:0}
|
||
.listingblock>.content{position:relative}
|
||
.listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999}
|
||
.listingblock:hover code[data-lang]:before{display:block}
|
||
.listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999}
|
||
.listingblock.terminal pre .command:not([data-prompt]):before{content:"$"}
|
||
table.pyhltable{border-collapse:separate;border:0;margin-bottom:0;background:none}
|
||
table.pyhltable td{vertical-align:top;padding-top:0;padding-bottom:0;line-height:1.45}
|
||
table.pyhltable td.code{padding-left:.75em;padding-right:0}
|
||
pre.pygments .lineno,table.pyhltable td:not(.code){color:#999;padding-left:0;padding-right:.5em;border-right:1px solid #ddddd8}
|
||
pre.pygments .lineno{display:inline-block;margin-right:.25em}
|
||
table.pyhltable .linenodiv{background:none!important;padding-right:0!important}
|
||
.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
|
||
.quoteblock>.title{margin-left:-1.5em;margin-bottom:.75em}
|
||
.quoteblock blockquote,.quoteblock blockquote p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
|
||
.quoteblock blockquote{margin:0;padding:0;border:0}
|
||
.quoteblock blockquote:before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
|
||
.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
|
||
.quoteblock .attribution{margin-top:.5em;margin-right:.5ex;text-align:right}
|
||
.quoteblock .quoteblock{margin-left:0;margin-right:0;padding:.5em 0;border-left:3px solid rgba(0,0,0,.6)}
|
||
.quoteblock .quoteblock blockquote{padding:0 0 0 .75em}
|
||
.quoteblock .quoteblock blockquote:before{display:none}
|
||
.verseblock{margin:0 1em 1.25em 1em}
|
||
.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
|
||
.verseblock pre strong{font-weight:400}
|
||
.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
|
||
.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
|
||
.quoteblock .attribution br,.verseblock .attribution br{display:none}
|
||
.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
|
||
.quoteblock.abstract{margin:0 0 1.25em 0;display:block}
|
||
.quoteblock.abstract blockquote,.quoteblock.abstract blockquote p{text-align:left;word-spacing:0}
|
||
.quoteblock.abstract blockquote:before,.quoteblock.abstract blockquote p:first-of-type:before{display:none}
|
||
table.tableblock{max-width:100%;border-collapse:separate}
|
||
table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0}
|
||
table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
|
||
table.grid-all>thead>tr>.tableblock,table.grid-all>tbody>tr>.tableblock{border-width:0 1px 1px 0}
|
||
table.grid-all>tfoot>tr>.tableblock{border-width:1px 1px 0 0}
|
||
table.grid-cols>*>tr>.tableblock{border-width:0 1px 0 0}
|
||
table.grid-rows>thead>tr>.tableblock,table.grid-rows>tbody>tr>.tableblock{border-width:0 0 1px 0}
|
||
table.grid-rows>tfoot>tr>.tableblock{border-width:1px 0 0 0}
|
||
table.grid-all>*>tr>.tableblock:last-child,table.grid-cols>*>tr>.tableblock:last-child{border-right-width:0}
|
||
table.grid-all>tbody>tr:last-child>.tableblock,table.grid-all>thead:last-child>tr>.tableblock,table.grid-rows>tbody>tr:last-child>.tableblock,table.grid-rows>thead:last-child>tr>.tableblock{border-bottom-width:0}
|
||
table.frame-all{border-width:1px}
|
||
table.frame-sides{border-width:0 1px}
|
||
table.frame-topbot{border-width:1px 0}
|
||
th.halign-left,td.halign-left{text-align:left}
|
||
th.halign-right,td.halign-right{text-align:right}
|
||
th.halign-center,td.halign-center{text-align:center}
|
||
th.valign-top,td.valign-top{vertical-align:top}
|
||
th.valign-bottom,td.valign-bottom{vertical-align:bottom}
|
||
th.valign-middle,td.valign-middle{vertical-align:middle}
|
||
table thead th,table tfoot th{font-weight:bold}
|
||
tbody tr th{display:table-cell;line-height:1.6;background:#f7f8f7}
|
||
tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
|
||
p.tableblock>code:only-child{background:none;padding:0}
|
||
p.tableblock{font-size:1em}
|
||
td>div.verse{white-space:pre}
|
||
ol{margin-left:1.75em}
|
||
ul li ol{margin-left:1.5em}
|
||
dl dd{margin-left:1.125em}
|
||
dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
|
||
ol>li p,ul>li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
|
||
ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
|
||
ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
|
||
ul.unstyled,ol.unstyled{margin-left:0}
|
||
ul.checklist{margin-left:.625em}
|
||
ul.checklist li>p:first-child>.fa-square-o:first-child,ul.checklist li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
|
||
ul.checklist li>p:first-child>input[type="checkbox"]:first-child{margin-right:.25em}
|
||
ul.inline{margin:0 auto .625em auto;margin-left:-1.375em;margin-right:0;padding:0;list-style:none;overflow:hidden}
|
||
ul.inline>li{list-style:none;float:left;margin-left:1.375em;display:block}
|
||
ul.inline>li>*{display:block}
|
||
.unstyled dl dt{font-weight:400;font-style:normal}
|
||
ol.arabic{list-style-type:decimal}
|
||
ol.decimal{list-style-type:decimal-leading-zero}
|
||
ol.loweralpha{list-style-type:lower-alpha}
|
||
ol.upperalpha{list-style-type:upper-alpha}
|
||
ol.lowerroman{list-style-type:lower-roman}
|
||
ol.upperroman{list-style-type:upper-roman}
|
||
ol.lowergreek{list-style-type:lower-greek}
|
||
.hdlist>table,.colist>table{border:0;background:none}
|
||
.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
|
||
td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
|
||
td.hdlist1{font-weight:bold;padding-bottom:1.25em}
|
||
.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
|
||
.colist>table tr>td:first-of-type{padding:.4em .75em 0 .75em;line-height:1;vertical-align:top}
|
||
.colist>table tr>td:first-of-type img{max-width:initial}
|
||
.colist>table tr>td:last-of-type{padding:.25em 0}
|
||
.thumb,.th{line-height:0;display:inline-block;border:solid 4px #fff;-webkit-box-shadow:0 0 0 1px #ddd;box-shadow:0 0 0 1px #ddd}
|
||
.imageblock.left,.imageblock[style*="float: left"]{margin:.25em .625em 1.25em 0}
|
||
.imageblock.right,.imageblock[style*="float: right"]{margin:.25em 0 1.25em .625em}
|
||
.imageblock>.title{margin-bottom:0}
|
||
.imageblock.thumb,.imageblock.th{border-width:6px}
|
||
.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
|
||
.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
|
||
.image.left{margin-right:.625em}
|
||
.image.right{margin-left:.625em}
|
||
a.image{text-decoration:none;display:inline-block}
|
||
a.image object{pointer-events:none}
|
||
sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
|
||
sup.footnote a,sup.footnoteref a{text-decoration:none}
|
||
sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
|
||
#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
|
||
#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em 0;border-width:1px 0 0 0}
|
||
#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;text-indent:-1.05em;margin-bottom:.2em}
|
||
#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none}
|
||
#footnotes .footnote:last-of-type{margin-bottom:0}
|
||
#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
|
||
.gist .file-data>table{border:0;background:#fff;width:100%;margin-bottom:0}
|
||
.gist .file-data>table td.line-data{width:99%}
|
||
div.unbreakable{page-break-inside:avoid}
|
||
.big{font-size:larger}
|
||
.small{font-size:smaller}
|
||
.underline{text-decoration:underline}
|
||
.overline{text-decoration:overline}
|
||
.line-through{text-decoration:line-through}
|
||
.aqua{color:#00bfbf}
|
||
.aqua-background{background-color:#00fafa}
|
||
.black{color:#000}
|
||
.black-background{background-color:#000}
|
||
.blue{color:#0000bf}
|
||
.blue-background{background-color:#0000fa}
|
||
.fuchsia{color:#bf00bf}
|
||
.fuchsia-background{background-color:#fa00fa}
|
||
.gray{color:#606060}
|
||
.gray-background{background-color:#7d7d7d}
|
||
.green{color:#006000}
|
||
.green-background{background-color:#007d00}
|
||
.lime{color:#00bf00}
|
||
.lime-background{background-color:#00fa00}
|
||
.maroon{color:#600000}
|
||
.maroon-background{background-color:#7d0000}
|
||
.navy{color:#000060}
|
||
.navy-background{background-color:#00007d}
|
||
.olive{color:#606000}
|
||
.olive-background{background-color:#7d7d00}
|
||
.purple{color:#600060}
|
||
.purple-background{background-color:#7d007d}
|
||
.red{color:#bf0000}
|
||
.red-background{background-color:#fa0000}
|
||
.silver{color:#909090}
|
||
.silver-background{background-color:#bcbcbc}
|
||
.teal{color:#006060}
|
||
.teal-background{background-color:#007d7d}
|
||
.white{color:#bfbfbf}
|
||
.white-background{background-color:#fafafa}
|
||
.yellow{color:#bfbf00}
|
||
.yellow-background{background-color:#fafa00}
|
||
span.icon>.fa{cursor:default}
|
||
a span.icon>.fa{cursor:inherit}
|
||
.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
|
||
.admonitionblock td.icon .icon-note:before{content:"\f05a";color:#19407c}
|
||
.admonitionblock td.icon .icon-tip:before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
|
||
.admonitionblock td.icon .icon-warning:before{content:"\f071";color:#bf6900}
|
||
.admonitionblock td.icon .icon-caution:before{content:"\f06d";color:#bf3400}
|
||
.admonitionblock td.icon .icon-important:before{content:"\f06a";color:#bf0000}
|
||
.conum[data-value]{display:inline-block;color:#fff!important;background-color:rgba(0,0,0,.8);-webkit-border-radius:100px;border-radius:100px;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
|
||
.conum[data-value] *{color:#fff!important}
|
||
.conum[data-value]+b{display:none}
|
||
.conum[data-value]:after{content:attr(data-value)}
|
||
pre .conum[data-value]{position:relative;top:-.125em}
|
||
b.conum *{color:inherit!important}
|
||
.conum:not([data-value]):empty{display:none}
|
||
dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
|
||
h1,h2,p,td.content,span.alt{letter-spacing:-.01em}
|
||
p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
|
||
p,blockquote,dt,td.content,span.alt{font-size:1.0625rem}
|
||
p{margin-bottom:1.25rem}
|
||
.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
|
||
.exampleblock>.content{background-color:#fffef7;border-color:#e0e0dc;-webkit-box-shadow:0 1px 4px #e0e0dc;box-shadow:0 1px 4px #e0e0dc}
|
||
.print-only{display:none!important}
|
||
@media print{@page{margin:1.25cm .75cm}
|
||
*{-webkit-box-shadow:none!important;box-shadow:none!important;text-shadow:none!important}
|
||
a{color:inherit!important;text-decoration:underline!important}
|
||
a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
|
||
a[href^="http:"]:not(.bare):after,a[href^="https:"]:not(.bare):after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
|
||
abbr[title]:after{content:" (" attr(title) ")"}
|
||
pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
|
||
thead{display:table-header-group}
|
||
svg{max-width:100%}
|
||
p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
|
||
h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
|
||
#toc,.sidebarblock,.exampleblock>.content{background:none!important}
|
||
#toc{border-bottom:1px solid #ddddd8!important;padding-bottom:0!important}
|
||
.sect1{padding-bottom:0!important}
|
||
.sect1+.sect1{border:0!important}
|
||
#header>h1:first-child{margin-top:1.25rem}
|
||
body.book #header{text-align:center}
|
||
body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em 0}
|
||
body.book #header .details{border:0!important;display:block;padding:0!important}
|
||
body.book #header .details span:first-child{margin-left:0!important}
|
||
body.book #header .details br{display:block}
|
||
body.book #header .details br+span:before{content:none!important}
|
||
body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
|
||
body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
|
||
.listingblock code[data-lang]:before{display:block}
|
||
#footer{background:none!important;padding:0 .9375em}
|
||
#footer-text{color:rgba(0,0,0,.6)!important;font-size:.9em}
|
||
.hide-on-print{display:none!important}
|
||
.print-only{display:block!important}
|
||
.hide-for-print{display:none!important}
|
||
.show-for-print{display:inherit!important}}
|
||
</style>
|
||
<style>
|
||
/* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */
|
||
/*pre.CodeRay {background-color:#f7f7f8;}*/
|
||
.CodeRay .line-numbers{border-right:1px solid #d8d8d8;padding:0 0.5em 0 .25em}
|
||
.CodeRay span.line-numbers{display:inline-block;margin-right:.5em;color:rgba(0,0,0,.3)}
|
||
.CodeRay .line-numbers strong{color:rgba(0,0,0,.4)}
|
||
table.CodeRay{border-collapse:separate;border-spacing:0;margin-bottom:0;border:0;background:none}
|
||
table.CodeRay td{vertical-align: top;line-height:1.45}
|
||
table.CodeRay td.line-numbers{text-align:right}
|
||
table.CodeRay td.line-numbers>pre{padding:0;color:rgba(0,0,0,.3)}
|
||
table.CodeRay td.code{padding:0 0 0 .5em}
|
||
table.CodeRay td.code>pre{padding:0}
|
||
.CodeRay .debug{color:#fff !important;background:#000080 !important}
|
||
.CodeRay .annotation{color:#007}
|
||
.CodeRay .attribute-name{color:#000080}
|
||
.CodeRay .attribute-value{color:#700}
|
||
.CodeRay .binary{color:#509}
|
||
.CodeRay .comment{color:#998;font-style:italic}
|
||
.CodeRay .char{color:#04d}
|
||
.CodeRay .char .content{color:#04d}
|
||
.CodeRay .char .delimiter{color:#039}
|
||
.CodeRay .class{color:#458;font-weight:bold}
|
||
.CodeRay .complex{color:#a08}
|
||
.CodeRay .constant,.CodeRay .predefined-constant{color:#008080}
|
||
.CodeRay .color{color:#099}
|
||
.CodeRay .class-variable{color:#369}
|
||
.CodeRay .decorator{color:#b0b}
|
||
.CodeRay .definition{color:#099}
|
||
.CodeRay .delimiter{color:#000}
|
||
.CodeRay .doc{color:#970}
|
||
.CodeRay .doctype{color:#34b}
|
||
.CodeRay .doc-string{color:#d42}
|
||
.CodeRay .escape{color:#666}
|
||
.CodeRay .entity{color:#800}
|
||
.CodeRay .error{color:#808}
|
||
.CodeRay .exception{color:inherit}
|
||
.CodeRay .filename{color:#099}
|
||
.CodeRay .function{color:#900;font-weight:bold}
|
||
.CodeRay .global-variable{color:#008080}
|
||
.CodeRay .hex{color:#058}
|
||
.CodeRay .integer,.CodeRay .float{color:#099}
|
||
.CodeRay .include{color:#555}
|
||
.CodeRay .inline{color:#000}
|
||
.CodeRay .inline .inline{background:#ccc}
|
||
.CodeRay .inline .inline .inline{background:#bbb}
|
||
.CodeRay .inline .inline-delimiter{color:#d14}
|
||
.CodeRay .inline-delimiter{color:#d14}
|
||
.CodeRay .important{color:#555;font-weight:bold}
|
||
.CodeRay .interpreted{color:#b2b}
|
||
.CodeRay .instance-variable{color:#008080}
|
||
.CodeRay .label{color:#970}
|
||
.CodeRay .local-variable{color:#963}
|
||
.CodeRay .octal{color:#40e}
|
||
.CodeRay .predefined{color:#369}
|
||
.CodeRay .preprocessor{color:#579}
|
||
.CodeRay .pseudo-class{color:#555}
|
||
.CodeRay .directive{font-weight:bold}
|
||
.CodeRay .type{font-weight:bold}
|
||
.CodeRay .predefined-type{color:inherit}
|
||
.CodeRay .reserved,.CodeRay .keyword {color:#000;font-weight:bold}
|
||
.CodeRay .key{color:#808}
|
||
.CodeRay .key .delimiter{color:#606}
|
||
.CodeRay .key .char{color:#80f}
|
||
.CodeRay .value{color:#088}
|
||
.CodeRay .regexp .delimiter{color:#808}
|
||
.CodeRay .regexp .content{color:#808}
|
||
.CodeRay .regexp .modifier{color:#808}
|
||
.CodeRay .regexp .char{color:#d14}
|
||
.CodeRay .regexp .function{color:#404;font-weight:bold}
|
||
.CodeRay .string{color:#d20}
|
||
.CodeRay .string .string .string{background:#ffd0d0}
|
||
.CodeRay .string .content{color:#d14}
|
||
.CodeRay .string .char{color:#d14}
|
||
.CodeRay .string .delimiter{color:#d14}
|
||
.CodeRay .shell{color:#d14}
|
||
.CodeRay .shell .delimiter{color:#d14}
|
||
.CodeRay .symbol{color:#990073}
|
||
.CodeRay .symbol .content{color:#a60}
|
||
.CodeRay .symbol .delimiter{color:#630}
|
||
.CodeRay .tag{color:#008080}
|
||
.CodeRay .tag-special{color:#d70}
|
||
.CodeRay .variable{color:#036}
|
||
.CodeRay .insert{background:#afa}
|
||
.CodeRay .delete{background:#faa}
|
||
.CodeRay .change{color:#aaf;background:#007}
|
||
.CodeRay .head{color:#f8f;background:#505}
|
||
.CodeRay .insert .insert{color:#080}
|
||
.CodeRay .delete .delete{color:#800}
|
||
.CodeRay .change .change{color:#66f}
|
||
.CodeRay .head .head{color:#f4f}
|
||
</style>
|
||
</head>
|
||
<body class="article toc2 toc-left">
|
||
<div id="header">
|
||
<h1>书栖网 服务端接口文档</h1>
|
||
<div id="toc" class="toc2">
|
||
<div id="toctitle">Table of Contents</div>
|
||
<ul class="sectlevel1">
|
||
<li><a href="#_overview">1. 概览</a>
|
||
<ul class="sectlevel2">
|
||
<li><a href="#_版本信息">1.1. 版本信息</a></li>
|
||
<li><a href="#_uri_scheme">1.2. URI scheme</a></li>
|
||
<li><a href="#_标签">1.3. 标签</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#_paths">2. 资源</a>
|
||
<ul class="sectlevel2">
|
||
<li><a href="#_261c63557a0a2affe4e9ee7cf30075c0">2.1. 书籍信息</a></li>
|
||
<li><a href="#_82c2171949c312f17a084ab9b31e7d55">2.2. 书籍分类信息</a></li>
|
||
<li><a href="#_631bcafa70826116dc02af62f26b6587">2.3. 导出数据</a></li>
|
||
<li><a href="#_5505c91c7c23d55a117904f2a3fe6081">2.4. 文件管理</a></li>
|
||
<li><a href="#_9083a36b9e1b060bcb75ff62bb4bda37">2.5. 用户操作</a></li>
|
||
<li><a href="#_4b02b6687df4f15fab50b8d31c1fc123">2.6. 第三方登录</a></li>
|
||
<li><a href="#_aca0f16a4237edba915fe70c9b07871c">2.7. 系统调试接口</a></li>
|
||
<li><a href="#_908e76a1e64eba3a29d68b89ae1eb608">2.8. 网站后台状态检测</a></li>
|
||
</ul>
|
||
</li>
|
||
<li><a href="#_definitions">3. 定义</a>
|
||
<ul class="sectlevel2">
|
||
<li><a href="#_commonreturntype">3.1. CommonReturnType</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div id="content">
|
||
<div class="sect1">
|
||
<h2 id="_overview">1. 概览</h2>
|
||
<div class="sectionbody">
|
||
<div class="paragraph">
|
||
<p>RESTful API | bookshelf.plus</p>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_版本信息">1.1. 版本信息</h3>
|
||
<div class="paragraph">
|
||
<p><em>版本</em> : 1.0</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_uri_scheme">1.2. URI scheme</h3>
|
||
<div class="paragraph">
|
||
<p><em>域名</em> : localhost:8090</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_标签">1.3. 标签</h3>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p>书籍信息 : Book Controller</p>
|
||
</li>
|
||
<li>
|
||
<p>书籍分类信息 : Category Controller</p>
|
||
</li>
|
||
<li>
|
||
<p>导出数据 : Export Controller</p>
|
||
</li>
|
||
<li>
|
||
<p>文件管理 : File Controller</p>
|
||
</li>
|
||
<li>
|
||
<p>用户操作 : User Controller</p>
|
||
</li>
|
||
<li>
|
||
<p>第三方登录 : Third Party Controller</p>
|
||
</li>
|
||
<li>
|
||
<p>系统调试接口 : System Controller</p>
|
||
</li>
|
||
<li>
|
||
<p>网站后台状态检测 : Status Controller</p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_paths">2. 资源</h2>
|
||
<div class="sectionbody">
|
||
<div class="sect2">
|
||
<h3 id="_261c63557a0a2affe4e9ee7cf30075c0">2.1. 书籍信息</h3>
|
||
<div class="paragraph">
|
||
<p>Book Controller</p>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_deletebookusingpost">2.1.1. 【管理员】删除书籍</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/book/delete</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明">说明</h5>
|
||
<div class="paragraph">
|
||
<p>管理员在后台删除书籍</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 22.2222%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 44.4445%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>id</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>integer (int32)</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/book/delete</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_detailusingpost">2.1.2. 【管理员】添加/修改书籍</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/book/detail</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_2">说明</h5>
|
||
<div class="paragraph">
|
||
<p>管理员在后台添加/修改书籍（bookId 传 0 或 null 或 不传 即为添加）</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_2">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 22.2222%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 44.4445%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>author</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>bookName</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>categoryId</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>integer (int32)</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>copyright</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>description</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>id</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>integer (int32)</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>isDelete</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>boolean</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>language</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>publishingHouse</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>thumbnail</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_2">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗_2">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_2">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_2">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_2">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/book/detail</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata_2">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_2">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_2">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_getusingget">2.1.3. 获取书籍信息</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>GET /api/book/get</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_3">说明</h5>
|
||
<div class="paragraph">
|
||
<p>获取书籍信息</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_3">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 11.1111%;">
|
||
<col style="width: 16.6666%;">
|
||
<col style="width: 50%;">
|
||
<col style="width: 22.2223%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Query</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>id</strong><br>
|
||
<em>必填</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>id</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>integer (int32)</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_3">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_3">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_3">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_3">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/book/get?id=0</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_3">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_3">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_getfavoriteslistusingpost">2.1.4. 【用户】用户收藏书籍列表</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/book/getFavoritesList</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_4">说明</h5>
|
||
<div class="paragraph">
|
||
<p>获取用户的收藏书籍列表</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_4">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 22.2222%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 44.4445%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_4">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗_3">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_4">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_4">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_4">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/book/getFavoritesList</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata_3">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_4">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_4">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_getfavoritesstatususingpost">2.1.5. 【用户】收藏/取消收藏书籍</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/book/getFavoritesStatus</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_5">说明</h5>
|
||
<div class="paragraph">
|
||
<p>用户收藏书籍</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_5">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 22.2222%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 44.4445%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>bookId</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>integer (int32)</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_5">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗_4">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_5">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_5">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_5">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/book/getFavoritesStatus</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata_4">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_5">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_5">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_searchusingget">2.1.6. 查询书籍列表</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>GET /api/book/search</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_6">说明</h5>
|
||
<div class="paragraph">
|
||
<p>通过指定条件查询书籍列表</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_6">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 11.1111%;">
|
||
<col style="width: 16.6666%;">
|
||
<col style="width: 50%;">
|
||
<col style="width: 22.2223%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Query</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>author</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>author</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Query</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>bookName</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>bookName</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Query</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>categoryId</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>categoryId</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>integer (int32)</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Query</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>id</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>id</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>integer (int32)</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Query</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>language</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>language</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Query</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>publishingHouse</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>publishingHouse</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_6">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_6">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_6">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_6">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/book/search</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_6">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_6">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_togglefavoritesusingpost">2.1.7. 【用户】收藏/取消收藏书籍</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/book/toggleFavorites</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_7">说明</h5>
|
||
<div class="paragraph">
|
||
<p>用户收藏书籍</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_7">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 22.2222%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 44.4445%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>bookId</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>integer (int32)</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>status</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>boolean</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_7">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗_5">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_7">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_7">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_7">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/book/toggleFavorites</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata_5">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_7">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_7">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_82c2171949c312f17a084ab9b31e7d55">2.2. 书籍分类信息</h3>
|
||
<div class="paragraph">
|
||
<p>Category Controller</p>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_getusingget_1">2.2.1. 获取指定分类</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>GET /api/category/get</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_8">说明</h5>
|
||
<div class="paragraph">
|
||
<p>获取指定的书籍分类</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_8">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 11.1111%;">
|
||
<col style="width: 16.6666%;">
|
||
<col style="width: 50%;">
|
||
<col style="width: 22.2223%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Query</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>id</strong><br>
|
||
<em>必填</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>id</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>integer (int32)</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_8">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_8">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_8">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_8">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/category/get?id=0</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_8">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_8">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_getallusingget">2.2.2. 获取所有分类</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>GET /api/category/list</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_9">说明</h5>
|
||
<div class="paragraph">
|
||
<p>获取所有的书籍分类</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_9">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_9">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_9">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_9">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/category/list</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_9">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_9">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_631bcafa70826116dc02af62f26b6587">2.3. 导出数据</h3>
|
||
<div class="paragraph">
|
||
<p>Export Controller</p>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_exportmarkdownusingpost">2.3.1. 【管理员】导出系统数据</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/export/markdown</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_10">说明</h5>
|
||
<div class="paragraph">
|
||
<p>将系统中的所有数据导出为markdown</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_9">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 22.2222%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 44.4445%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_10">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗_6">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_10">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_10">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_10">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/export/markdown</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata_6">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_10">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_10">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_5505c91c7c23d55a117904f2a3fe6081">2.4. 文件管理</h3>
|
||
<div class="paragraph">
|
||
<p>File Controller</p>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_cosusingpost">2.4.1. 【用户|管理员】创建腾讯云 COS 预授权 URL</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/file/cos/{httpMethod}</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_10">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 11.1111%;">
|
||
<col style="width: 16.6666%;">
|
||
<col style="width: 50%;">
|
||
<col style="width: 22.2223%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Path</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>httpMethod</strong><br>
|
||
<em>必填</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>httpMethod</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>expireMinute</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>integer (int32)</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>fileExt</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>fileId</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>integer (int32)</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>fileName</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>fileNameAndExt</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>fileSha1</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>fileSize</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>integer (int64)</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>lastModified</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>integer (int64)</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>visitorId</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_11">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗_7">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_11">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_11">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_11">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/file/cos/string</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata_7">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_11">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_11">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_getfileusingget">2.4.2. 书籍下载页面获取文件提供的下载方式</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>GET /api/file/getFile</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_11">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 11.1111%;">
|
||
<col style="width: 16.6666%;">
|
||
<col style="width: 50%;">
|
||
<col style="width: 22.2223%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Query</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>bookId</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>bookId</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>integer (int32)</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_12">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_12">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_12">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_12">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/file/getFile</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_12">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_12">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_listusingpost">2.4.3. 【管理员】查询文件列表</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/file/list</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_11">说明</h5>
|
||
<div class="paragraph">
|
||
<p>查询文件列表</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_12">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 22.2222%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 44.4445%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_13">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗_8">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_13">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_13">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_13">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/file/list</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata_8">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_13">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_13">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_matchfilehashusingpost">2.4.4. 【管理员】查询文件列表（匹配文件哈希）</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/file/list/MatchfileHash</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_12">说明</h5>
|
||
<div class="paragraph">
|
||
<p>查询文件列表，返回文件哈希为空或者相同的文件</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_13">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 22.2222%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 44.4445%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>fileSha1</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_14">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗_9">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_14">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_14">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_14">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/file/list/MatchfileHash</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata_9">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_14">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_14">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_failurefeedbackusingpost">2.4.5. 链接失效反馈</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/file/object/FailureFeedback</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_13">说明</h5>
|
||
<div class="paragraph">
|
||
<p>查询文件列表</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_14">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 22.2222%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 44.4445%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>bookId</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>integer (int32)</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>fileId</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>integer (int32)</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>fileObjectId</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>integer (int32)</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>visitorId</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_15">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗_10">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_15">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_15">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_15">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/file/object/FailureFeedback</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata_10">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_15">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_15">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_objectlistusingpost">2.4.6. 【管理员】查询文件对象列表</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/file/object/list</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_14">说明</h5>
|
||
<div class="paragraph">
|
||
<p>查询文件列表</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_15">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 22.2222%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 44.4445%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_16">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗_11">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_16">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_16">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_16">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/file/object/list</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata_11">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_16">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_16">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_refreshfileobjectstatususingpost">2.4.7. 【管理员】更新文件对象上传状态</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/file/object/refreshFileObjectStatus</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_15">说明</h5>
|
||
<div class="paragraph">
|
||
<p>重新从 COS 对象存储中获取文件对象上传状态</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_16">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 22.2222%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 44.4445%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>fileObjectId</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>integer (int32)</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_17">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗_12">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_17">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_17">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_17">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/file/object/refreshFileObjectStatus</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata_12">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_17">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_17">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_coscheckfilestatususingpost">2.4.8. 【COS】腾讯云 COS 文件上传成功回调</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/file/upload/cos-check-file-state</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_16">说明</h5>
|
||
<div class="paragraph">
|
||
<p>客户端向腾讯云 COS 存储桶上传文件完毕，有云函数触发此请求</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_17">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 22.2222%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 44.4445%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>context</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>event</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_18">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗_13">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_18">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_18">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_18">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/file/upload/cos-check-file-state</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata_13">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_18">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_18">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_9083a36b9e1b060bcb75ff62bb4bda37">2.5. 用户操作</h3>
|
||
<div class="paragraph">
|
||
<p>User Controller</p>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_cancelaccountusingpost">2.5.1. 【用户】账号注销</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/user/cancelAccount</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_17">说明</h5>
|
||
<div class="paragraph">
|
||
<p>传入用户 token ，以及密码明文，后台计算密码SHA1值，进行注销</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_18">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 22.2222%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 44.4445%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>password</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_19">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗_14">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_19">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_19">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_19">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/user/cancelAccount</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata_14">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_19">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_19">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_getuserstatususingpost">2.5.2. 获取用户登录状态</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/user/getUserStatus</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_18">说明</h5>
|
||
<div class="paragraph">
|
||
<p>获取用户登录状态</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_19">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 22.2222%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 44.4445%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_20">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗_15">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_20">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_20">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_20">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/user/getUserStatus</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata_15">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_20">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_20">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_loginusingpost">2.5.3. 用户登录</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/user/login</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_19">说明</h5>
|
||
<div class="paragraph">
|
||
<p>传入用户名，以及密码明文，后台计算密码SHA1值，进行登录</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_20">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 22.2222%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 44.4445%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>password</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>username</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>visitorId</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_21">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗_16">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_21">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_21">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_21">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/user/login</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata_16">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_21">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_21">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_logoutusingpost">2.5.4. 【用户|管理员】用户登出</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/user/logout</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_20">说明</h5>
|
||
<div class="paragraph">
|
||
<p>用户退出登录</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_21">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 22.2222%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 44.4445%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_22">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗_17">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_22">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_22">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_22">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/user/logout</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata_17">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_22">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_22">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_registerusingpost">2.5.5. 用户注册</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/user/register</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_21">说明</h5>
|
||
<div class="paragraph">
|
||
<p>传入用户名，以及密码明文，后台计算密码SHA1值，进行注册</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_22">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 22.2222%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 44.4445%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>password</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>username</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>visitorId</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_23">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗_18">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_23">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_23">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_23">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/user/register</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata_18">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_23">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_23">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_4b02b6687df4f15fab50b8d31c1fc123">2.6. 第三方登录</h3>
|
||
<div class="paragraph">
|
||
<p>Third Party Controller</p>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_callbackusingget">2.6.1. 快捷登录回调函数</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>GET /api/third-party/callback/{platform}</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_22">说明</h5>
|
||
<div class="paragraph">
|
||
<p>如果传入 token 那么就是绑定第三方账号到当前登录账号，否则就是通过第三方授权登录</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_23">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 11.1111%;">
|
||
<col style="width: 16.6666%;">
|
||
<col style="width: 50%;">
|
||
<col style="width: 22.2223%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Path</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>platform</strong><br>
|
||
<em>必填</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>platform</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Query</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>auth_code</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Query</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>authorization_code</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Query</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>code</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Query</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>oauth_token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Query</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>oauth_verifier</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Query</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>state</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Query</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>token</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_24">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_24">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_24">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_24">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/third-party/callback/string</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_24">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_24">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_getbindingstatususingget">2.6.2. 【用户|管理员】获取用户已绑定的第三方平台</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>GET /api/third-party/getBindingStatus</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_23">说明</h5>
|
||
<div class="paragraph">
|
||
<p>传入当前登录用户 token ，返回已绑定的第三方平台</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_24">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 11.1111%;">
|
||
<col style="width: 16.6666%;">
|
||
<col style="width: 50%;">
|
||
<col style="width: 22.2223%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Query</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>token</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_25">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_25">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_25">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_25">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/third-party/getBindingStatus</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_25">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_25">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_loginusingget">2.6.3. 第三方用户登录跳转地址</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>GET /api/third-party/login</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_24">说明</h5>
|
||
<div class="paragraph">
|
||
<p>传入需要登录的第三方平台（大小写均可），返回跳转url</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_25">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 11.1111%;">
|
||
<col style="width: 16.6666%;">
|
||
<col style="width: 50%;">
|
||
<col style="width: 22.2223%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>Query</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>platform</strong><br>
|
||
<em>必填</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>platform</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_26">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_26">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_26">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_26">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/third-party/login?platform=string</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_26">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_26">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_unbindthirdpartaccountusingpost">2.6.4. 【用户|管理员】取消第三方平台绑定</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/third-party/withdrawThirdPartyBings</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_25">说明</h5>
|
||
<div class="paragraph">
|
||
<p>传入当前登录用户 token 和平台 platform （不区分大小写），返回 bool 值，true 为取消绑定成功</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_26">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 22.2222%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 44.4445%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>platform</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_27">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗_19">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_27">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_27">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_27">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/third-party/withdrawThirdPartyBings</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata_19">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_27">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_27">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_aca0f16a4237edba915fe70c9b07871c">2.7. 系统调试接口</h3>
|
||
<div class="paragraph">
|
||
<p>System Controller</p>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_statususingpost">2.7.1. 【管理员】获取系统配置</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>POST /api/system/status</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_26">说明</h5>
|
||
<div class="paragraph">
|
||
<p>仅限管理员登录状态下可获取</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_参数_27">参数</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 22.2222%;">
|
||
<col style="width: 33.3333%;">
|
||
<col style="width: 44.4445%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>FormData</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>token</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_28">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>201</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Created</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_消耗_20">消耗</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>application/x-www-form-urlencoded</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_28">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_28">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_28">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/system/status</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect5">
|
||
<h6 id="_请求_formdata_20">请求 formData</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json"><span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span></code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_28">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_28">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect2">
|
||
<h3 id="_908e76a1e64eba3a29d68b89ae1eb608">2.8. 网站后台状态检测</h3>
|
||
<div class="paragraph">
|
||
<p>Status Controller</p>
|
||
</div>
|
||
<div class="sect3">
|
||
<h4 id="_getusingget_2">2.8.1. 系统状态</h4>
|
||
<div class="literalblock">
|
||
<div class="content">
|
||
<pre>GET /api/status/get</pre>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_说明_27">说明</h5>
|
||
<div class="paragraph">
|
||
<p>获取服务器当前系统负载。SystemLoadAverage返回-1时代表不支持。</p>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_响应_29">响应</h5>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 10%;">
|
||
<col style="width: 70%;">
|
||
<col style="width: 20%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">HTTP代码</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>200</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>OK</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><a href="#_commonreturntype">CommonReturnType</a></p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>401</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Unauthorized</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>403</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Forbidden</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>404</strong></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>Not Found</p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>无内容</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_生成_29">生成</h5>
|
||
<div class="ulist">
|
||
<ul>
|
||
<li>
|
||
<p><code>*/*</code></p>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http请求示例_29">HTTP请求示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_请求_path_29">请求 path</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre>/api/status/get</pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect4">
|
||
<h5 id="_http响应示例_29">HTTP响应示例</h5>
|
||
<div class="sect5">
|
||
<h6 id="_响应_200_29">响应 200</h6>
|
||
<div class="listingblock">
|
||
<div class="content">
|
||
<pre class="CodeRay highlight"><code data-lang="json">{
|
||
<span class="key"><span class="delimiter">"</span><span class="content">data</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">object</span><span class="delimiter">"</span></span>,
|
||
<span class="key"><span class="delimiter">"</span><span class="content">status</span><span class="delimiter">"</span></span> : <span class="string"><span class="delimiter">"</span><span class="content">string</span><span class="delimiter">"</span></span>
|
||
}</code></pre>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="sect1">
|
||
<h2 id="_definitions">3. 定义</h2>
|
||
<div class="sectionbody">
|
||
<div class="sect2">
|
||
<h3 id="_commonreturntype">3.1. CommonReturnType</h3>
|
||
<table class="tableblock frame-all grid-all spread">
|
||
<colgroup>
|
||
<col style="width: 16.6666%;">
|
||
<col style="width: 61.1111%;">
|
||
<col style="width: 22.2223%;">
|
||
</colgroup>
|
||
<thead>
|
||
<tr>
|
||
<th class="tableblock halign-left valign-middle">名称</th>
|
||
<th class="tableblock halign-left valign-middle">说明</th>
|
||
<th class="tableblock halign-left valign-middle">类型</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>data</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>样例</strong> : <code>"object"</code></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>object</p>
|
||
</div></div></td>
|
||
</tr>
|
||
<tr>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>status</strong><br>
|
||
<em>可选</em></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p><strong>样例</strong> : <code>"string"</code></p>
|
||
</div></div></td>
|
||
<td class="tableblock halign-left valign-middle"><div><div class="paragraph">
|
||
<p>string</p>
|
||
</div></div></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="footer">
|
||
<div id="footer-text">
|
||
Last updated 2022-04-19 23:43:31 SGT
|
||
</div>
|
||
</div>
|
||
</body>
|
||
</html> |