|
|
<!DOCTYPE html>
|
|
|
<html>
|
|
|
<head>
|
|
|
<title>苍穹外卖-管理端接口</title>
|
|
|
<meta charset="utf-8" />
|
|
|
<style>@charset "UTF-8";
|
|
|
html,
|
|
|
body,
|
|
|
h1,
|
|
|
h2,
|
|
|
h3,
|
|
|
h4,
|
|
|
h5,
|
|
|
h6,
|
|
|
p,
|
|
|
blockquote {
|
|
|
margin: 0;
|
|
|
padding: 0;
|
|
|
font-weight: normal;
|
|
|
-webkit-font-smoothing: antialiased;
|
|
|
}
|
|
|
|
|
|
/* 设置滚动条的样式 */
|
|
|
::-webkit-scrollbar {
|
|
|
width: 6px;
|
|
|
}
|
|
|
|
|
|
/* 外层轨道 */
|
|
|
::-webkit-scrollbar-track {
|
|
|
-webkit-box-shadow: inset006pxrgba(255, 0, 0, 0.3);
|
|
|
background: rgba(0, 0, 0, 0.1);
|
|
|
}
|
|
|
|
|
|
/* 滚动条滑块 */
|
|
|
::-webkit-scrollbar-thumb {
|
|
|
border-radius: 4px;
|
|
|
background: rgba(0, 0, 0, 0.2);
|
|
|
-webkit-box-shadow: inset006pxrgba(0, 0, 0, 0.5);
|
|
|
}
|
|
|
|
|
|
::-webkit-scrollbar-thumb:window-inactive {
|
|
|
background: rgba(0, 0, 0, 0.2);
|
|
|
}
|
|
|
|
|
|
body {
|
|
|
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Helvetica, "PingFang SC", "Hiragino Sans GB", "Microsoft YaHei", SimSun, sans-serif;
|
|
|
font-size: 13px;
|
|
|
line-height: 25px;
|
|
|
color: #393838;
|
|
|
position: relative;
|
|
|
}
|
|
|
|
|
|
table {
|
|
|
margin: 10px 0 15px 0;
|
|
|
border-collapse: collapse;
|
|
|
}
|
|
|
|
|
|
td,
|
|
|
th {
|
|
|
border: 1px solid #ddd;
|
|
|
padding: 3px 10px;
|
|
|
}
|
|
|
|
|
|
th {
|
|
|
padding: 5px 10px;
|
|
|
}
|
|
|
|
|
|
a, a:link, a:visited {
|
|
|
color: #34495e;
|
|
|
text-decoration: none;
|
|
|
}
|
|
|
|
|
|
a:hover, a:focus {
|
|
|
color: #59d69d;
|
|
|
text-decoration: none;
|
|
|
}
|
|
|
|
|
|
a img {
|
|
|
border: none;
|
|
|
}
|
|
|
|
|
|
p {
|
|
|
padding-left: 10px;
|
|
|
margin-bottom: 9px;
|
|
|
}
|
|
|
|
|
|
h1,
|
|
|
h2,
|
|
|
h3,
|
|
|
h4,
|
|
|
h5,
|
|
|
h6 {
|
|
|
color: #404040;
|
|
|
line-height: 36px;
|
|
|
}
|
|
|
|
|
|
h1 {
|
|
|
color: #2c3e50;
|
|
|
font-weight: 600;
|
|
|
margin-bottom: 16px;
|
|
|
font-size: 32px;
|
|
|
padding-bottom: 16px;
|
|
|
border-bottom: 1px solid #ddd;
|
|
|
line-height: 50px;
|
|
|
}
|
|
|
|
|
|
h2 {
|
|
|
font-size: 28px;
|
|
|
padding-top: 10px;
|
|
|
padding-bottom: 10px;
|
|
|
}
|
|
|
|
|
|
h3 {
|
|
|
clear: both;
|
|
|
font-weight: 400;
|
|
|
margin-top: 20px;
|
|
|
margin-bottom: 20px;
|
|
|
border-left: 3px solid #59d69d;
|
|
|
padding-left: 8px;
|
|
|
font-size: 18px;
|
|
|
}
|
|
|
|
|
|
h4 {
|
|
|
font-size: 16px;
|
|
|
}
|
|
|
|
|
|
h5 {
|
|
|
font-size: 14px;
|
|
|
}
|
|
|
|
|
|
h6 {
|
|
|
font-size: 13px;
|
|
|
}
|
|
|
|
|
|
hr {
|
|
|
margin: 0 0 19px;
|
|
|
border: 0;
|
|
|
border-bottom: 1px solid #ccc;
|
|
|
}
|
|
|
|
|
|
blockquote {
|
|
|
padding: 13px 13px 21px 15px;
|
|
|
margin-bottom: 18px;
|
|
|
font-family: georgia, serif;
|
|
|
font-style: italic;
|
|
|
}
|
|
|
|
|
|
blockquote:before {
|
|
|
font-size: 40px;
|
|
|
margin-left: -10px;
|
|
|
font-family: georgia, serif;
|
|
|
color: #eee;
|
|
|
}
|
|
|
|
|
|
blockquote p {
|
|
|
font-size: 14px;
|
|
|
font-weight: 300;
|
|
|
line-height: 18px;
|
|
|
margin-bottom: 0;
|
|
|
font-style: italic;
|
|
|
}
|
|
|
|
|
|
code,
|
|
|
pre {
|
|
|
font-family: Monaco, Andale Mono, Courier New, monospace;
|
|
|
}
|
|
|
|
|
|
code {
|
|
|
background-color: #fee9cc;
|
|
|
color: rgba(0, 0, 0, 0.75);
|
|
|
padding: 1px 3px;
|
|
|
font-size: 12px;
|
|
|
-webkit-border-radius: 3px;
|
|
|
-moz-border-radius: 3px;
|
|
|
border-radius: 3px;
|
|
|
}
|
|
|
|
|
|
pre {
|
|
|
display: block;
|
|
|
padding: 14px;
|
|
|
margin: 0 0 18px;
|
|
|
line-height: 16px;
|
|
|
font-size: 11px;
|
|
|
border: 1px solid #d9d9d9;
|
|
|
white-space: pre-wrap;
|
|
|
word-wrap: break-word;
|
|
|
background: #f6f6f6;
|
|
|
}
|
|
|
|
|
|
pre code {
|
|
|
background-color: #f6f6f6;
|
|
|
color: #737373;
|
|
|
font-size: 11px;
|
|
|
padding: 0;
|
|
|
}
|
|
|
|
|
|
sup {
|
|
|
font-size: 0.83em;
|
|
|
vertical-align: super;
|
|
|
line-height: 0;
|
|
|
}
|
|
|
|
|
|
* {
|
|
|
-webkit-print-color-adjust: exact;
|
|
|
}
|
|
|
|
|
|
@media print {
|
|
|
body,
|
|
|
code,
|
|
|
pre code,
|
|
|
h1,
|
|
|
h2,
|
|
|
h3,
|
|
|
h4,
|
|
|
h5,
|
|
|
h6 {
|
|
|
color: black;
|
|
|
}
|
|
|
|
|
|
table,
|
|
|
pre {
|
|
|
page-break-inside: avoid;
|
|
|
}
|
|
|
}
|
|
|
html,
|
|
|
body {
|
|
|
height: 100%;
|
|
|
}
|
|
|
|
|
|
.table-of-contents {
|
|
|
position: fixed;
|
|
|
top: 61px;
|
|
|
left: 0;
|
|
|
bottom: 0;
|
|
|
overflow-x: hidden;
|
|
|
overflow-y: auto;
|
|
|
width: 260px;
|
|
|
}
|
|
|
|
|
|
.table-of-contents > ul > li > a {
|
|
|
font-size: 20px;
|
|
|
margin-bottom: 16px;
|
|
|
margin-top: 16px;
|
|
|
}
|
|
|
|
|
|
.table-of-contents ul {
|
|
|
overflow: auto;
|
|
|
margin: 0px;
|
|
|
height: 100%;
|
|
|
padding: 0px 0px;
|
|
|
box-sizing: border-box;
|
|
|
list-style-type: none;
|
|
|
}
|
|
|
|
|
|
.table-of-contents ul li {
|
|
|
padding-left: 20px;
|
|
|
}
|
|
|
|
|
|
.table-of-contents a {
|
|
|
padding: 2px 0px;
|
|
|
display: block;
|
|
|
text-decoration: none;
|
|
|
}
|
|
|
|
|
|
.content-right {
|
|
|
max-width: 700px;
|
|
|
margin-left: 290px;
|
|
|
padding-left: 70px;
|
|
|
flex-grow: 1;
|
|
|
}
|
|
|
.content-right h2:target {
|
|
|
padding-top: 80px;
|
|
|
}
|
|
|
|
|
|
body > p {
|
|
|
margin-left: 30px;
|
|
|
}
|
|
|
|
|
|
body > table {
|
|
|
margin-left: 30px;
|
|
|
}
|
|
|
|
|
|
body > pre {
|
|
|
margin-left: 30px;
|
|
|
}
|
|
|
|
|
|
.curProject {
|
|
|
position: fixed;
|
|
|
top: 20px;
|
|
|
font-size: 25px;
|
|
|
color: black;
|
|
|
margin-left: -240px;
|
|
|
width: 240px;
|
|
|
padding: 5px;
|
|
|
line-height: 25px;
|
|
|
box-sizing: border-box;
|
|
|
}
|
|
|
|
|
|
.g-doc {
|
|
|
margin-top: 56px;
|
|
|
padding-top: 24px;
|
|
|
display: flex;
|
|
|
}
|
|
|
|
|
|
.curproject-name {
|
|
|
font-size: 42px;
|
|
|
}
|
|
|
|
|
|
.m-header {
|
|
|
background: #32363a;
|
|
|
height: 56px;
|
|
|
line-height: 56px;
|
|
|
padding-left: 60px;
|
|
|
display: flex;
|
|
|
align-items: center;
|
|
|
position: fixed;
|
|
|
z-index: 9;
|
|
|
top: 0;
|
|
|
left: 0;
|
|
|
right: 0;
|
|
|
}
|
|
|
.m-header .title {
|
|
|
font-size: 22px;
|
|
|
color: #fff;
|
|
|
font-weight: normal;
|
|
|
-webkit-font-smoothing: antialiased;
|
|
|
margin: 0;
|
|
|
margin-left: 16px;
|
|
|
padding: 0;
|
|
|
line-height: 56px;
|
|
|
border: none;
|
|
|
}
|
|
|
.m-header .nav {
|
|
|
color: #fff;
|
|
|
font-size: 16px;
|
|
|
position: absolute;
|
|
|
right: 32px;
|
|
|
top: 0;
|
|
|
}
|
|
|
.m-header .nav a {
|
|
|
color: #fff;
|
|
|
margin-left: 16px;
|
|
|
padding: 8px;
|
|
|
transition: color .2s;
|
|
|
}
|
|
|
.m-header .nav a:hover {
|
|
|
color: #59d69d;
|
|
|
}
|
|
|
|
|
|
.m-footer {
|
|
|
border-top: 1px solid #ddd;
|
|
|
padding-top: 16px;
|
|
|
padding-bottom: 16px;
|
|
|
}
|
|
|
|
|
|
/*# sourceMappingURL=defaultTheme.css.map */
|
|
|
</style>
|
|
|
</head>
|
|
|
<body>
|
|
|
<div class="m-header">
|
|
|
<a href="#" style="display: inherit;"><svg class="svg" width="32px" height="32px" viewBox="0 0 64 64" version="1.1"><title>Icon</title><desc>Created with Sketch.</desc><defs><linearGradient x1="50%" y1="0%" x2="50%" y2="100%" id="linearGradient-1"><stop stop-color="#FFFFFF" offset="0%"></stop><stop stop-color="#F2F2F2" offset="100%"></stop></linearGradient><circle id="path-2" cx="31.9988602" cy="31.9988602" r="2.92886048"></circle><filter x="-85.4%" y="-68.3%" width="270.7%" height="270.7%" filterUnits="objectBoundingBox" id="filter-3"><feOffset dx="0" dy="1" in="SourceAlpha" result="shadowOffsetOuter1"></feOffset><feGaussianBlur stdDeviation="1.5" in="shadowOffsetOuter1" result="shadowBlurOuter1"></feGaussianBlur><feColorMatrix values="0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0.159703351 0" type="matrix" in="shadowBlurOuter1"></feColorMatrix></filter></defs><g id="首页" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd"><g id="大屏幕"><g id="Icon"><circle id="Oval-1" fill="url(#linearGradient-1)" cx="32" cy="32" r="32"></circle><path d="M36.7078009,31.8054514 L36.7078009,51.7110548 C36.7078009,54.2844537 34.6258634,56.3695395 32.0579205,56.3695395 C29.4899777,56.3695395 27.4099998,54.0704461 27.4099998,51.7941246 L27.4099998,31.8061972 C27.4099998,29.528395 29.4909575,27.218453 32.0589004,27.230043 C34.6268432,27.241633 36.7078009,29.528395 36.7078009,31.8054514 Z" id="blue" fill="#2359F1" fill-rule="nonzero"></path><path d="M45.2586091,17.1026914 C45.2586091,17.1026914 45.5657231,34.0524383 45.2345291,37.01141 C44.9033351,39.9703817 43.1767091,41.6667796 40.6088126,41.6667796 C38.040916,41.6667796 35.9609757,39.3676862 35.9609757,37.0913646 L35.9609757,17.1034372 C35.9609757,14.825635 38.0418959,12.515693 40.6097924,12.527283 C43.177689,12.538873 45.2586091,14.825635 45.2586091,17.1026914 Z" id="green" fill="#57CF27" fill-rule="nonzero" transform="translate(40.674608, 27.097010) rotate(60.000000) translate(-40.674608, -27.097010) "></path><path d="M28.0410158,17.0465598 L28.0410158,36.9521632 C28.0410158,39.525562 25.9591158,41.6106479 23.3912193,41.6106479 C20.8233227,41.6106479 18.7433824,39.3115545 18.7433824,37.035233 L18.7433824,17.0473055 C18.7433824,14.7695034 20.8243026,12.4595614 23.3921991,12.4711513 C25.9600956,12.4827413 28.0410158,14.7695034 28.0410158,17.0465598 Z" id="red" fill="#FF561B" fill-rule="nonzero" transform="translate(23.392199, 27.040878) rotate(-60.000000) translate(-23.392199, -27.040878) "></path><g id="inner-round"><use fill="black" fill-opacity="1" filter="url(#filter-3)" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#path-2"></use><use fill="#F7F7F7" fill-rule="evenodd" xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="#path-2"></use></g></g></g></g></svg></a>
|
|
|
<a href="#"><h1 class="title">YAPI 接口文档</h1></a>
|
|
|
<div class="nav">
|
|
|
<a href="https://hellosean1025.github.io/yapi/">YApi</a>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="g-doc">
|
|
|
<div class="table-of-contents"><ul><li><a href="#u5206u7c7bu76f8u5173u63a5u53e3">分类相关接口</a><ul><li><a href="#u4feeu6539u5206u7c7b0a3ca20id3du4feeu6539u5206u7c7b3e203ca3e">修改分类
|
|
|
<a id=修改分类> </a></a></li><li><a href="#u5206u7c7bu5206u9875u67e5u8be20a3ca20id3du5206u7c7bu5206u9875u67e5u8be23e203ca3e">分类分页查询
|
|
|
<a id=分类分页查询> </a></a></li><li><a href="#u542fu7528u3001u7981u7528u5206u7c7b0a3ca20id3du542fu7528u3001u7981u7528u5206u7c7b3e203ca3e">启用、禁用分类
|
|
|
<a id=启用、禁用分类> </a></a></li><li><a href="#u65b0u589eu5206u7c7b0a3ca20id3du65b0u589eu5206u7c7b3e203ca3e">新增分类
|
|
|
<a id=新增分类> </a></a></li><li><a href="#u6839u636eidu5220u9664u5206u7c7b0a3ca20id3du6839u636eidu5220u9664u5206u7c7b3e203ca3e">根据id删除分类
|
|
|
<a id=根据id删除分类> </a></a></li><li><a href="#u6839u636eu7c7bu578bu67e5u8be2u5206u7c7b0a3ca20id3du6839u636eu7c7bu578bu67e5u8be2u5206u7c7b3e203ca3e">根据类型查询分类
|
|
|
<a id=根据类型查询分类> </a></a></li></ul></li><li><a href="#u5458u5de5u76f8u5173u63a5u53e3">员工相关接口</a><ul><li><a href="#u4feeu6539u5bc6u78010a3ca20id3du4feeu6539u5bc6u78013e203ca3e">修改密码
|
|
|
<a id=修改密码> </a></a></li><li><a href="#u542fu7528u3001u7981u7528u5458u5de5u8d26u53f70a3ca20id3du542fu7528u3001u7981u7528u5458u5de5u8d26u53f73e203ca3e">启用、禁用员工账号
|
|
|
<a id=启用、禁用员工账号> </a></a></li><li><a href="#u5458u5de5u5206u9875u67e5u8be20a3ca20id3du5458u5de5u5206u9875u67e5u8be23e203ca3e">员工分页查询
|
|
|
<a id=员工分页查询> </a></a></li><li><a href="#u5458u5de5u767bu5f550a3ca20id3du5458u5de5u767bu5f553e203ca3e">员工登录
|
|
|
<a id=员工登录> </a></a></li><li><a href="#u65b0u589eu5458u5de50a3ca20id3du65b0u589eu5458u5de53e203ca3e">新增员工
|
|
|
<a id=新增员工> </a></a></li><li><a href="#u6839u636eidu67e5u8be2u5458u5de50a3ca20id3du6839u636eidu67e5u8be2u5458u5de53e203ca3e">根据id查询员工
|
|
|
<a id=根据id查询员工> </a></a></li><li><a href="#u7f16u8f91u5458u5de5u4fe1u606f0a3ca20id3du7f16u8f91u5458u5de5u4fe1u606f3e203ca3e">编辑员工信息
|
|
|
<a id=编辑员工信息> </a></a></li><li><a href="#u9000u51fau767bu5f550a3ca20id3du9000u51fau767bu5f553e203ca3e">退出登录
|
|
|
<a id=退出登录> </a></a></li></ul></li><li><a href="#u5957u9910u76f8u5173u63a5u53e3">套餐相关接口</a><ul><li><a href="#u4feeu6539u5957u99100a3ca20id3du4feeu6539u5957u99103e203ca3e">修改套餐
|
|
|
<a id=修改套餐> </a></a></li><li><a href="#u5206u9875u67e5u8be20a3ca20id3du5206u9875u67e5u8be23e203ca3e">分页查询
|
|
|
<a id=分页查询> </a></a></li><li><a href="#u5957u9910u8d77u552eu3001u505cu552e0a3ca20id3du5957u9910u8d77u552eu3001u505cu552e3e203ca3e">套餐起售、停售
|
|
|
<a id=套餐起售、停售> </a></a></li><li><a href="#u6279u91cfu5220u9664u5957u99100a3ca20id3du6279u91cfu5220u9664u5957u99103e203ca3e">批量删除套餐
|
|
|
<a id=批量删除套餐> </a></a></li><li><a href="#u65b0u589eu5957u99100a3ca20id3du65b0u589eu5957u99103e203ca3e">新增套餐
|
|
|
<a id=新增套餐> </a></a></li><li><a href="#u6839u636eidu67e5u8be2u5957u99100a3ca20id3du6839u636eidu67e5u8be2u5957u99103e203ca3e">根据id查询套餐
|
|
|
<a id=根据id查询套餐> </a></a></li></ul></li><li><a href="#u5de5u4f5cu53f0u63a5u53e3">工作台接口</a><ul><li><a href="#u67e5u8be2u4ecau65e5u8fd0u8425u6570u636e0a3ca20id3du67e5u8be2u4ecau65e5u8fd0u8425u6570u636e3e203ca3e">查询今日运营数据
|
|
|
<a id=查询今日运营数据> </a></a></li><li><a href="#u67e5u8be2u5957u9910u603bu89c80a3ca20id3du67e5u8be2u5957u9910u603bu89c83e203ca3e">查询套餐总览
|
|
|
<a id=查询套餐总览> </a></a></li><li><a href="#u67e5u8be2u83dcu54c1u603bu89c80a3ca20id3du67e5u8be2u83dcu54c1u603bu89c83e203ca3e">查询菜品总览
|
|
|
<a id=查询菜品总览> </a></a></li><li><a href="#u67e5u8be2u8ba2u5355u7ba1u7406u6570u636e0a3ca20id3du67e5u8be2u8ba2u5355u7ba1u7406u6570u636e3e203ca3e">查询订单管理数据
|
|
|
<a id=查询订单管理数据> </a></a></li></ul></li><li><a href="#u5e97u94fau64cdu4f5cu63a5u53e3">店铺操作接口</a><ul><li><a href="#u83b7u53d6u8425u4e1au72b6u60010a3ca20id3du83b7u53d6u8425u4e1au72b6u60013e203ca3e">获取营业状态
|
|
|
<a id=获取营业状态> </a></a></li><li><a href="#u8bbeu7f6eu8425u4e1au72b6u60010a3ca20id3du8bbeu7f6eu8425u4e1au72b6u60013e203ca3e">设置营业状态
|
|
|
<a id=设置营业状态> </a></a></li></ul></li><li><a href="#u6570u636eu7edfu8ba1u76f8u5173u63a5u53e3">数据统计相关接口</a><ul><li><a href="#u5bfcu51faexcelu62a5u8868u63a5u53e30a3ca20id3du5bfcu51faexcelu62a5u8868u63a5u53e33e203ca3e">导出Excel报表接口
|
|
|
<a id=导出Excel报表接口> </a></a></li><li><a href="#u67e5u8be2u9500u91cfu6392u540dtop10u63a5u53e30a3ca20id3du67e5u8be2u9500u91cfu6392u540dtop10u63a5u53e33e203ca3e">查询销量排名top10接口
|
|
|
<a id=查询销量排名top10接口> </a></a></li><li><a href="#u7528u6237u7edfu8ba1u63a5u53e30a3ca20id3du7528u6237u7edfu8ba1u63a5u53e33e203ca3e">用户统计接口
|
|
|
<a id=用户统计接口> </a></a></li><li><a href="#u8425u4e1au989du7edfu8ba1u63a5u53e30a3ca20id3du8425u4e1au989du7edfu8ba1u63a5u53e33e203ca3e">营业额统计接口
|
|
|
<a id=营业额统计接口> </a></a></li><li><a href="#u8ba2u5355u7edfu8ba1u63a5u53e30a3ca20id3du8ba2u5355u7edfu8ba1u63a5u53e33e203ca3e">订单统计接口
|
|
|
<a id=订单统计接口> </a></a></li></ul></li><li><a href="#u83dcu54c1u76f8u5173u63a5u53e3">菜品相关接口</a><ul><li><a href="#u4feeu6539u83dcu54c10a3ca20id3du4feeu6539u83dcu54c13e203ca3e">修改菜品
|
|
|
<a id=修改菜品> </a></a></li><li><a href="#u6279u91cfu5220u9664u83dcu54c10a3ca20id3du6279u91cfu5220u9664u83dcu54c13e203ca3e">批量删除菜品
|
|
|
<a id=批量删除菜品> </a></a></li><li><a href="#u65b0u589eu83dcu54c10a3ca20id3du65b0u589eu83dcu54c13e203ca3e">新增菜品
|
|
|
<a id=新增菜品> </a></a></li><li><a href="#u6839u636eidu67e5u8be2u83dcu54c10a3ca20id3du6839u636eidu67e5u8be2u83dcu54c13e203ca3e">根据id查询菜品
|
|
|
<a id=根据id查询菜品> </a></a></li><li><a href="#u6839u636eu5206u7c7bidu67e5u8be2u83dcu54c10a3ca20id3du6839u636eu5206u7c7bidu67e5u8be2u83dcu54c13e203ca3e">根据分类id查询菜品
|
|
|
<a id=根据分类id查询菜品> </a></a></li><li><a href="#u83dcu54c1u5206u9875u67e5u8be20a3ca20id3du83dcu54c1u5206u9875u67e5u8be23e203ca3e">菜品分页查询
|
|
|
<a id=菜品分页查询> </a></a></li><li><a href="#u83dcu54c1u8d77u552eu3001u505cu552e0a3ca20id3du83dcu54c1u8d77u552eu3001u505cu552e3e203ca3e">菜品起售、停售
|
|
|
<a id=菜品起售、停售> </a></a></li></ul></li><li><a href="#u8ba2u5355u7ba1u7406u63a5u53e3">订单管理接口</a><ul><li><a href="#u53d6u6d88u8ba2u53550a3ca20id3du53d6u6d88u8ba2u53553e203ca3e">取消订单
|
|
|
<a id=取消订单> </a></a></li><li><a href="#u5404u4e2au72b6u6001u7684u8ba2u5355u6570u91cfu7edfu8ba10a3ca20id3du5404u4e2au72b6u6001u7684u8ba2u5355u6570u91cfu7edfu8ba13e203ca3e">各个状态的订单数量统计
|
|
|
<a id=各个状态的订单数量统计> </a></a></li><li><a href="#u5b8cu6210u8ba2u53550a3ca20id3du5b8cu6210u8ba2u53553e203ca3e">完成订单
|
|
|
<a id=完成订单> </a></a></li><li><a href="#u62d2u53550a3ca20id3du62d2u53553e203ca3e">拒单
|
|
|
<a id=拒单> </a></a></li><li><a href="#u63a5u53550a3ca20id3du63a5u53553e203ca3e">接单
|
|
|
<a id=接单> </a></a></li><li><a href="#u67e5u8be2u8ba2u5355u8be6u60c50a3ca20id3du67e5u8be2u8ba2u5355u8be6u60c53e203ca3e">查询订单详情
|
|
|
<a id=查询订单详情> </a></a></li><li><a href="#u6d3eu9001u8ba2u53550a3ca20id3du6d3eu9001u8ba2u53553e203ca3e">派送订单
|
|
|
<a id=派送订单> </a></a></li><li><a href="#u8ba2u5355u641cu7d220a3ca20id3du8ba2u5355u641cu7d223e203ca3e">订单搜索
|
|
|
<a id=订单搜索> </a></a></li></ul></li><li><a href="#u901au7528u63a5u53e3">通用接口</a><ul><li><a href="#u6587u4ef6u4e0au4f200a3ca20id3du6587u4ef6u4e0au4f203e203ca3e">文件上传
|
|
|
<a id=文件上传> </a></a></li></ul></li></ul></div>
|
|
|
<div id="right" class="content-right">
|
|
|
<h1 class="curproject-name"> 苍穹外卖-管理端接口 </h1>
|
|
|
<h1 id="u5206u7c7bu76f8u5173u63a5u53e3">分类相关接口</h1>
|
|
|
<p></p>
|
|
|
<h2 id="u4feeu6539u5206u7c7b0a3ca20id3du4feeu6539u5206u7c7b3e203ca3e">修改分类
|
|
|
<a id=修改分类> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/category</p>
|
|
|
<p><strong>Method：</strong> PUT</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-2">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>Body</strong></p>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> id</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">分类id</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">分类名称</span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> sort</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">排序</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-3><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> type</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">分类类型</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-3">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u5206u7c7bu5206u9875u67e5u8be20a3ca20id3du5206u7c7bu5206u9875u67e5u8be23e203ca3e">分类分页查询
|
|
|
<a id=分类分页查询> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-4">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/category/page</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-5">请求参数</h3>
|
|
|
<p><strong>Query</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>name</td>
|
|
|
<td>否</td>
|
|
|
<td>传统主食</td>
|
|
|
<td>分类名称</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>page</td>
|
|
|
<td>是</td>
|
|
|
<td>1</td>
|
|
|
<td>页码</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>pageSize</td>
|
|
|
<td>是</td>
|
|
|
<td>10</td>
|
|
|
<td>每页记录数</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>type</td>
|
|
|
<td>否</td>
|
|
|
<td>1</td>
|
|
|
<td>分类类型：1为菜品分类，2为套餐分类</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-6">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>null</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> total</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> records</span></td><td key=1><span>object []</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=3><span style="font-weight: '700'">item 类型: </span><span>object</span></p></td></tr><tr key=0-2-1-0><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> id</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-1><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> type</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-2><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-3><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> sort</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-4><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> status</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-5><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> createTime</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-6><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> updateTime</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-7><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> createUser</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-8><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> updateUser</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u542fu7528u3001u7981u7528u5206u7c7b0a3ca20id3du542fu7528u3001u7981u7528u5206u7c7b3e203ca3e">启用、禁用分类
|
|
|
<a id=启用、禁用分类> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-7">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/category/status/{status}</p>
|
|
|
<p><strong>Method：</strong> POST</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-8">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>路径参数</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>status</td>
|
|
|
<td>1</td>
|
|
|
<td>1为启用，0为禁用</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>Query</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>id</td>
|
|
|
<td>是</td>
|
|
|
<td>100</td>
|
|
|
<td>分类id</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-9">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u65b0u589eu5206u7c7b0a3ca20id3du65b0u589eu5206u7c7b3e203ca3e">新增分类
|
|
|
<a id=新增分类> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-10">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/category</p>
|
|
|
<p><strong>Method：</strong> POST</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-11">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>Body</strong></p>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> id</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">分类名称</span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> sort</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">排序，按照升序排序</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-3><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> type</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">分类类型：1为菜品分类，2为套餐分类</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-12">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u6839u636eidu5220u9664u5206u7c7b0a3ca20id3du6839u636eidu5220u9664u5206u7c7b3e203ca3e">根据id删除分类
|
|
|
<a id=根据id删除分类> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-13">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/category</p>
|
|
|
<p><strong>Method：</strong> DELETE</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-14">请求参数</h3>
|
|
|
<p><strong>Query</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>id</td>
|
|
|
<td>是</td>
|
|
|
<td>100</td>
|
|
|
<td>分类id</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-15">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u6839u636eu7c7bu578bu67e5u8be2u5206u7c7b0a3ca20id3du6839u636eu7c7bu578bu67e5u8be2u5206u7c7b3e203ca3e">根据类型查询分类
|
|
|
<a id=根据类型查询分类> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-16">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/category/list</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-17">请求参数</h3>
|
|
|
<p><strong>Query</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>type</td>
|
|
|
<td>否</td>
|
|
|
<td>2</td>
|
|
|
<td>分类类型：1为菜品分类，2为套餐分类</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-18">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object []</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=3><span style="font-weight: '700'">item 类型: </span><span>object</span></p></td></tr><tr key=0-1-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> createTime</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=4><span style="font-weight: '700'">format: </span><span>date-time</span></p></td></tr><tr key=0-1-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> createUser</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-2><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> id</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-3><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> name</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-4><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> sort</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-5><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> status</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-6><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> type</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-7><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> updateTime</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=4><span style="font-weight: '700'">format: </span><span>date-time</span></p></td></tr><tr key=0-1-8><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> updateUser</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h1 id="u5458u5de5u76f8u5173u63a5u53e3">员工相关接口</h1>
|
|
|
<p></p>
|
|
|
<h2 id="u4feeu6539u5bc6u78010a3ca20id3du4feeu6539u5bc6u78013e203ca3e">修改密码
|
|
|
<a id=修改密码> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-19">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/employee/editPassword</p>
|
|
|
<p><strong>Method：</strong> PUT</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-20">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>Body</strong></p>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> empId</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">员工id</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> newPassword</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">新密码</span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> oldPassword</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">旧密码</span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-21">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u542fu7528u3001u7981u7528u5458u5de5u8d26u53f70a3ca20id3du542fu7528u3001u7981u7528u5458u5de5u8d26u53f73e203ca3e">启用、禁用员工账号
|
|
|
<a id=启用、禁用员工账号> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-22">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/employee/status/{status}</p>
|
|
|
<p><strong>Method：</strong> POST</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-23">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>路径参数</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>status</td>
|
|
|
<td>1</td>
|
|
|
<td>状态，1为启用 0为禁用</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>Query</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>id</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td>员工id</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-24">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u5458u5de5u5206u9875u67e5u8be20a3ca20id3du5458u5de5u5206u9875u67e5u8be23e203ca3e">员工分页查询
|
|
|
<a id=员工分页查询> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-25">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/employee/page</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-26">请求参数</h3>
|
|
|
<p><strong>Query</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>name</td>
|
|
|
<td>否</td>
|
|
|
<td>张三</td>
|
|
|
<td>员工姓名</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>page</td>
|
|
|
<td>是</td>
|
|
|
<td>1</td>
|
|
|
<td>页码</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>pageSize</td>
|
|
|
<td>是</td>
|
|
|
<td>10</td>
|
|
|
<td>每页记录数</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-27">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>null</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> total</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> records</span></td><td key=1><span>object []</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=3><span style="font-weight: '700'">item 类型: </span><span>object</span></p></td></tr><tr key=0-2-1-0><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> id</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-1><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> username</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-2><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-3><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> password</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-4><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> phone</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-5><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> sex</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-6><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> idNumber</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-7><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> status</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-8><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> createTime</span></td><td key=1><span>string,null</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-9><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> updateTime</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-10><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> createUser</span></td><td key=1><span>number,null</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-11><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> updateUser</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u5458u5de5u767bu5f550a3ca20id3du5458u5de5u767bu5f553e203ca3e">员工登录
|
|
|
<a id=员工登录> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-28">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/employee/login</p>
|
|
|
<p><strong>Method：</strong> POST</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-29">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>Body</strong></p>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> password</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">密码</span></td><td key=5></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> username</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">用户名</span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-30">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">员工登录返回的数据格式</span></td><td key=5></td></tr><tr key=0-1-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> id</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">主键值</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> name</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">姓名</span></td><td key=5></td></tr><tr key=0-1-2><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> token</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">jwt令牌</span></td><td key=5></td></tr><tr key=0-1-3><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> userName</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">用户名</span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u65b0u589eu5458u5de50a3ca20id3du65b0u589eu5458u5de53e203ca3e">新增员工
|
|
|
<a id=新增员工> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-31">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/employee</p>
|
|
|
<p><strong>Method：</strong> POST</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-32">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>Body</strong></p>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> id</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">员工id</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> idNumber</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">身份证</span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">姓名</span></td><td key=5></td></tr><tr key=0-3><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> phone</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">手机号</span></td><td key=5></td></tr><tr key=0-4><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> sex</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">性别</span></td><td key=5></td></tr><tr key=0-5><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> username</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">用户名</span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-33">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u6839u636eidu67e5u8be2u5458u5de50a3ca20id3du6839u636eidu67e5u8be2u5458u5de53e203ca3e">根据id查询员工
|
|
|
<a id=根据id查询员工> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-34">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/employee/{id}</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-35">请求参数</h3>
|
|
|
<p><strong>路径参数</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>id</td>
|
|
|
<td>100</td>
|
|
|
<td>员工id</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-36">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> createTime</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=4><span style="font-weight: '700'">format: </span><span>date-time</span></p></td></tr><tr key=0-1-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> createUser</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-2><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> id</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-3><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> idNumber</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-4><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> name</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-5><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> password</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-6><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> phone</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-7><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> sex</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-8><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> status</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-9><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> updateTime</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=4><span style="font-weight: '700'">format: </span><span>date-time</span></p></td></tr><tr key=0-1-10><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> updateUser</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-11><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> username</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u7f16u8f91u5458u5de5u4fe1u606f0a3ca20id3du7f16u8f91u5458u5de5u4fe1u606f3e203ca3e">编辑员工信息
|
|
|
<a id=编辑员工信息> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-37">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/employee</p>
|
|
|
<p><strong>Method：</strong> PUT</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-38">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>Body</strong></p>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> id</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> idNumber</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-3><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> phone</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-4><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> sex</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-5><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> username</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-39">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u9000u51fau767bu5f550a3ca20id3du9000u51fau767bu5f553e203ca3e">退出登录
|
|
|
<a id=退出登录> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-40">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/employee/logout</p>
|
|
|
<p><strong>Method：</strong> POST</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-41">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>Body</strong></p>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody">
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-42">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h1 id="u5957u9910u76f8u5173u63a5u53e3">套餐相关接口</h1>
|
|
|
<p></p>
|
|
|
<h2 id="u4feeu6539u5957u99100a3ca20id3du4feeu6539u5957u99103e203ca3e">修改套餐
|
|
|
<a id=修改套餐> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-43">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/setmeal</p>
|
|
|
<p><strong>Method：</strong> PUT</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-44">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>Body</strong></p>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> categoryId</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">分类id</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> description</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">套餐描述</span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> id</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">套餐id</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-3><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> image</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">套餐图片路径</span></td><td key=5></td></tr><tr key=0-4><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">套餐名称</span></td><td key=5></td></tr><tr key=0-5><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> price</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">套餐价格</span></td><td key=5></td></tr><tr key=0-6><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> setmealDishes</span></td><td key=1><span>object []</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">套餐和菜品关联关系</span></td><td key=5><p key=3><span style="font-weight: '700'">item 类型: </span><span>object</span></p></td></tr><tr key=0-6-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> copies</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">菜品份数</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-6-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> dishId</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">菜品id</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-6-2><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> id</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">关系表主键值</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-6-3><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">菜品名称</span></td><td key=5></td></tr><tr key=0-6-4><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> price</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">菜品价格</span></td><td key=5></td></tr><tr key=0-6-5><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> setmealId</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">套餐id</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-7><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> status</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">套餐起售状态</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-45">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u5206u9875u67e5u8be20a3ca20id3du5206u9875u67e5u8be23e203ca3e">分页查询
|
|
|
<a id=分页查询> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-46">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/setmeal/page</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-47">请求参数</h3>
|
|
|
<p><strong>Query</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>categoryId</td>
|
|
|
<td>否</td>
|
|
|
<td></td>
|
|
|
<td>分类id</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>name</td>
|
|
|
<td>否</td>
|
|
|
<td></td>
|
|
|
<td>套餐名称</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>page</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td>页码</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>pageSize</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td>每页记录数</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>status</td>
|
|
|
<td>否</td>
|
|
|
<td></td>
|
|
|
<td>套餐起售状态</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-48">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>null</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> total</span></td><td key=1><span>number</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> records</span></td><td key=1><span>object []</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=3><span style="font-weight: '700'">item 类型: </span><span>object</span></p></td></tr><tr key=0-2-1-0><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> id</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-1><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> categoryId</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-2><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-3><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> price</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-4><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> status</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-5><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> description</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-6><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> image</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-7><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> updateTime</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-8><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> categoryName</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u5957u9910u8d77u552eu3001u505cu552e0a3ca20id3du5957u9910u8d77u552eu3001u505cu552e3e203ca3e">套餐起售、停售
|
|
|
<a id=套餐起售、停售> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-49">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/setmeal/status/{status}</p>
|
|
|
<p><strong>Method：</strong> POST</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-50">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>路径参数</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>status</td>
|
|
|
<td>1</td>
|
|
|
<td>套餐状态，1表示起售，0表示停售</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>Query</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>id</td>
|
|
|
<td>是</td>
|
|
|
<td>101</td>
|
|
|
<td>套餐id</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-51">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u6279u91cfu5220u9664u5957u99100a3ca20id3du6279u91cfu5220u9664u5957u99103e203ca3e">批量删除套餐
|
|
|
<a id=批量删除套餐> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-52">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/setmeal</p>
|
|
|
<p><strong>Method：</strong> DELETE</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-53">请求参数</h3>
|
|
|
<p><strong>Query</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>ids</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td>ids</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-54">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u65b0u589eu5957u99100a3ca20id3du65b0u589eu5957u99103e203ca3e">新增套餐
|
|
|
<a id=新增套餐> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-55">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/setmeal</p>
|
|
|
<p><strong>Method：</strong> POST</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-56">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>Body</strong></p>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> categoryId</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">分类id</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> description</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">套餐描述</span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> id</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">套餐id</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-3><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> image</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">套餐图片</span></td><td key=5></td></tr><tr key=0-4><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">套餐名称</span></td><td key=5></td></tr><tr key=0-5><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> price</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">套餐价格</span></td><td key=5></td></tr><tr key=0-6><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> setmealDishes</span></td><td key=1><span>object []</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">套餐包含的菜品</span></td><td key=5><p key=3><span style="font-weight: '700'">item 类型: </span><span>object</span></p></td></tr><tr key=0-6-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> copies</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">份数</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-6-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> dishId</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">菜品id</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-6-2><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> id</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">套餐和菜品关系id</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-6-3><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">菜品名称</span></td><td key=5></td></tr><tr key=0-6-4><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> price</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">菜品价格</span></td><td key=5></td></tr><tr key=0-6-5><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> setmealId</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">套餐id</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-7><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> status</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">套餐状态：1位起售 0为停售</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-57">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u6839u636eidu67e5u8be2u5957u99100a3ca20id3du6839u636eidu67e5u8be2u5957u99103e203ca3e">根据id查询套餐
|
|
|
<a id=根据id查询套餐> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-58">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/setmeal/{id}</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-59">请求参数</h3>
|
|
|
<p><strong>路径参数</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>id</td>
|
|
|
<td>101</td>
|
|
|
<td>套餐id</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-60">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> categoryId</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> categoryName</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-2><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> description</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-3><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> id</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-4><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> image</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-5><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-6><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> price</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-7><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> setmealDishes</span></td><td key=1><span>object []</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=3><span style="font-weight: '700'">item 类型: </span><span>object</span></p></td></tr><tr key=0-1-7-0><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> copies</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-7-1><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> dishId</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-7-2><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> id</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-7-3><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-7-4><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> price</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-7-5><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> setmealId</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-8><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> status</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-9><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> updateTime</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=4><span style="font-weight: '700'">format: </span><span>date-time</span></p></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h1 id="u5de5u4f5cu53f0u63a5u53e3">工作台接口</h1>
|
|
|
<p></p>
|
|
|
<h2 id="u67e5u8be2u4ecau65e5u8fd0u8425u6570u636e0a3ca20id3du67e5u8be2u4ecau65e5u8fd0u8425u6570u636e3e203ca3e">查询今日运营数据
|
|
|
<a id=查询今日运营数据> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-61">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/workspace/businessData</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-62">请求参数</h3>
|
|
|
<h3 id="-63">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> newUsers</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">新增用户数</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> orderCompletionRate</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">订单完成率</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>double</span></p></td></tr><tr key=0-1-2><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> turnover</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">营业额</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>double</span></p></td></tr><tr key=0-1-3><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> unitPrice</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">平均客单价</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>double</span></p></td></tr><tr key=0-1-4><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> validOrderCount</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">有效订单数</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u67e5u8be2u5957u9910u603bu89c80a3ca20id3du67e5u8be2u5957u9910u603bu89c83e203ca3e">查询套餐总览
|
|
|
<a id=查询套餐总览> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-64">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/workspace/overviewSetmeals</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-65">请求参数</h3>
|
|
|
<h3 id="-66">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> discontinued</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">已停售套餐数量</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> sold</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">已启售套餐数量</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u67e5u8be2u83dcu54c1u603bu89c80a3ca20id3du67e5u8be2u83dcu54c1u603bu89c83e203ca3e">查询菜品总览
|
|
|
<a id=查询菜品总览> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-67">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/workspace/overviewDishes</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-68">请求参数</h3>
|
|
|
<h3 id="-69">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> discontinued</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">已停售菜品数量</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> sold</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">已启售菜品数量</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u67e5u8be2u8ba2u5355u7ba1u7406u6570u636e0a3ca20id3du67e5u8be2u8ba2u5355u7ba1u7406u6570u636e3e203ca3e">查询订单管理数据
|
|
|
<a id=查询订单管理数据> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-70">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/workspace/overviewOrders</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-71">请求参数</h3>
|
|
|
<h3 id="-72">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> allOrders</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">全部订单</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> cancelledOrders</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">已取消数量</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-2><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> completedOrders</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">已完成数量</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-3><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> deliveredOrders</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">待派送数量</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-4><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> waitingOrders</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">待接单数量</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h1 id="u5e97u94fau64cdu4f5cu63a5u53e3">店铺操作接口</h1>
|
|
|
<p></p>
|
|
|
<h2 id="u83b7u53d6u8425u4e1au72b6u60010a3ca20id3du83b7u53d6u8425u4e1au72b6u60013e203ca3e">获取营业状态
|
|
|
<a id=获取营业状态> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-73">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/shop/status</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-74">请求参数</h3>
|
|
|
<h3 id="-75">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">店铺营业状态：1为营业，0为打烊</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u8bbeu7f6eu8425u4e1au72b6u60010a3ca20id3du8bbeu7f6eu8425u4e1au72b6u60013e203ca3e">设置营业状态
|
|
|
<a id=设置营业状态> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-76">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/shop/{status}</p>
|
|
|
<p><strong>Method：</strong> PUT</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-77">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>路径参数</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>status</td>
|
|
|
<td>1</td>
|
|
|
<td>店铺营业状态：1为营业，0为打烊</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-78">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h1 id="u6570u636eu7edfu8ba1u76f8u5173u63a5u53e3">数据统计相关接口</h1>
|
|
|
<p></p>
|
|
|
<h2 id="u5bfcu51faexcelu62a5u8868u63a5u53e30a3ca20id3du5bfcu51faexcelu62a5u8868u63a5u53e33e203ca3e">导出Excel报表接口
|
|
|
<a id=导出Excel报表接口> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-79">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/report/export</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-80">请求参数</h3>
|
|
|
<h3 id="-81">返回数据</h3>
|
|
|
<pre><code class="language-javascript">OK
|
|
|
</code></pre>
|
|
|
<h2 id="u67e5u8be2u9500u91cfu6392u540dtop10u63a5u53e30a3ca20id3du67e5u8be2u9500u91cfu6392u540dtop10u63a5u53e33e203ca3e">查询销量排名top10接口
|
|
|
<a id=查询销量排名top10接口> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-82">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/report/top10</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-83">请求参数</h3>
|
|
|
<p><strong>Query</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>begin</td>
|
|
|
<td>是</td>
|
|
|
<td>2022-05-01</td>
|
|
|
<td>开始日期</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>end</td>
|
|
|
<td>是</td>
|
|
|
<td>2022-05-31</td>
|
|
|
<td>结束日期</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-84">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> nameList</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">商品名称列表，以逗号分隔</span></td><td key=5></td></tr><tr key=0-1-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> numberList</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">销量列表，以逗号分隔</span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u7528u6237u7edfu8ba1u63a5u53e30a3ca20id3du7528u6237u7edfu8ba1u63a5u53e33e203ca3e">用户统计接口
|
|
|
<a id=用户统计接口> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-85">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/report/userStatistics</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-86">请求参数</h3>
|
|
|
<p><strong>Query</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>begin</td>
|
|
|
<td>是</td>
|
|
|
<td>2022-05-01</td>
|
|
|
<td>开始日期</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>end</td>
|
|
|
<td>是</td>
|
|
|
<td>2022-05-31</td>
|
|
|
<td>结束日期</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-87">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> dateList</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">日期列表，以逗号分隔</span></td><td key=5></td></tr><tr key=0-1-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> newUserList</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">新增用户数列表，以逗号分隔</span></td><td key=5></td></tr><tr key=0-1-2><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> totalUserList</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">总用户量列表，以逗号分隔</span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u8425u4e1au989du7edfu8ba1u63a5u53e30a3ca20id3du8425u4e1au989du7edfu8ba1u63a5u53e33e203ca3e">营业额统计接口
|
|
|
<a id=营业额统计接口> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-88">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/report/turnoverStatistics</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-89">请求参数</h3>
|
|
|
<p><strong>Query</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>begin</td>
|
|
|
<td>是</td>
|
|
|
<td>2022-05-01</td>
|
|
|
<td>开始日期</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>end</td>
|
|
|
<td>是</td>
|
|
|
<td>2022-05-31</td>
|
|
|
<td>结束日期</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-90">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> dateList</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">日期列表，日期之间以逗号分隔</span></td><td key=5></td></tr><tr key=0-1-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> turnoverList</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">营业额列表，营业额之间以逗号分隔</span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u8ba2u5355u7edfu8ba1u63a5u53e30a3ca20id3du8ba2u5355u7edfu8ba1u63a5u53e33e203ca3e">订单统计接口
|
|
|
<a id=订单统计接口> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-91">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/report/ordersStatistics</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-92">请求参数</h3>
|
|
|
<p><strong>Query</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>begin</td>
|
|
|
<td>是</td>
|
|
|
<td>2022-05-01</td>
|
|
|
<td>开始日期</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>end</td>
|
|
|
<td>是</td>
|
|
|
<td>2022-05-31</td>
|
|
|
<td>结束日期</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-93">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> dateList</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">日期列表，以逗号分隔</span></td><td key=5></td></tr><tr key=0-1-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> orderCompletionRate</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">订单完成率</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>double</span></p></td></tr><tr key=0-1-2><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> orderCountList</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">订单数列表，以逗号分隔</span></td><td key=5></td></tr><tr key=0-1-3><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> totalOrderCount</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">订单总数</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-4><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> validOrderCount</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">有效订单数</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-5><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> validOrderCountList</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">有效订单数列表，以逗号分隔</span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h1 id="u83dcu54c1u76f8u5173u63a5u53e3">菜品相关接口</h1>
|
|
|
<p></p>
|
|
|
<h2 id="u4feeu6539u83dcu54c10a3ca20id3du4feeu6539u83dcu54c13e203ca3e">修改菜品
|
|
|
<a id=修改菜品> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-94">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/dish</p>
|
|
|
<p><strong>Method：</strong> PUT</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-95">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>Body</strong></p>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> categoryId</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> description</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> flavors</span></td><td key=1><span>object []</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=3><span style="font-weight: '700'">item 类型: </span><span>object</span></p></td></tr><tr key=0-2-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> dishId</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-2-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> id</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-2-2><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-3><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> value</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-3><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> id</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-4><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> image</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-5><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-6><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> price</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-7><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> status</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-96">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u6279u91cfu5220u9664u83dcu54c10a3ca20id3du6279u91cfu5220u9664u83dcu54c13e203ca3e">批量删除菜品
|
|
|
<a id=批量删除菜品> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-97">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/dish</p>
|
|
|
<p><strong>Method：</strong> DELETE</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-98">请求参数</h3>
|
|
|
<p><strong>Query</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>ids</td>
|
|
|
<td>是</td>
|
|
|
<td>1,2,3</td>
|
|
|
<td>菜品id，之间用逗号分隔</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-99">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u65b0u589eu83dcu54c10a3ca20id3du65b0u589eu83dcu54c13e203ca3e">新增菜品
|
|
|
<a id=新增菜品> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-100">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/dish</p>
|
|
|
<p><strong>Method：</strong> POST</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-101">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>Body</strong></p>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> categoryId</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">分类id</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> description</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">菜品描述</span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> flavors</span></td><td key=1><span>object []</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">口味</span></td><td key=5><p key=3><span style="font-weight: '700'">item 类型: </span><span>object</span></p></td></tr><tr key=0-2-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> dishId</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">菜品id</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-2-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> id</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">口味id</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-2-2><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">口味名称</span></td><td key=5></td></tr><tr key=0-2-3><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> value</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">口味值</span></td><td key=5></td></tr><tr key=0-3><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> id</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">菜品id</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-4><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> image</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">菜品图片路径</span></td><td key=5></td></tr><tr key=0-5><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">菜品名称</span></td><td key=5></td></tr><tr key=0-6><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> price</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">菜品价格</span></td><td key=5></td></tr><tr key=0-7><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> status</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">菜品状态：1为起售，0为停售</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-102">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u6839u636eidu67e5u8be2u83dcu54c10a3ca20id3du6839u636eidu67e5u8be2u83dcu54c13e203ca3e">根据id查询菜品
|
|
|
<a id=根据id查询菜品> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-103">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/dish/{id}</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-104">请求参数</h3>
|
|
|
<p><strong>路径参数</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>id</td>
|
|
|
<td>101</td>
|
|
|
<td>菜品id</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-105">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> categoryId</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> categoryName</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-2><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> description</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-3><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> flavors</span></td><td key=1><span>object []</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=3><span style="font-weight: '700'">item 类型: </span><span>object</span></p></td></tr><tr key=0-1-3-0><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> dishId</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-3-1><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> id</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-3-2><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-3-3><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> value</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-4><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> id</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-5><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> image</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-6><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-7><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> price</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-8><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> status</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-9><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> updateTime</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=4><span style="font-weight: '700'">format: </span><span>date-time</span></p></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u6839u636eu5206u7c7bidu67e5u8be2u83dcu54c10a3ca20id3du6839u636eu5206u7c7bidu67e5u8be2u83dcu54c13e203ca3e">根据分类id查询菜品
|
|
|
<a id=根据分类id查询菜品> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-106">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/dish/list</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-107">请求参数</h3>
|
|
|
<p><strong>Query</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>categoryId</td>
|
|
|
<td>是</td>
|
|
|
<td>101</td>
|
|
|
<td>分类id</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-108">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object []</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=3><span style="font-weight: '700'">item 类型: </span><span>object</span></p></td></tr><tr key=0-1-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> categoryId</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> createTime</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=4><span style="font-weight: '700'">format: </span><span>date-time</span></p></td></tr><tr key=0-1-2><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> createUser</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-3><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> description</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-4><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> id</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-5><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> image</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-6><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> name</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-7><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> price</span></td><td key=1><span>number</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-8><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> status</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-9><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> updateTime</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=4><span style="font-weight: '700'">format: </span><span>date-time</span></p></td></tr><tr key=0-1-10><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> updateUser</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u83dcu54c1u5206u9875u67e5u8be20a3ca20id3du83dcu54c1u5206u9875u67e5u8be23e203ca3e">菜品分页查询
|
|
|
<a id=菜品分页查询> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-109">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/dish/page</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-110">请求参数</h3>
|
|
|
<p><strong>Query</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>categoryId</td>
|
|
|
<td>否</td>
|
|
|
<td>101</td>
|
|
|
<td>分类id</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>name</td>
|
|
|
<td>否</td>
|
|
|
<td>宫保鸡丁</td>
|
|
|
<td>菜品名称</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>page</td>
|
|
|
<td>是</td>
|
|
|
<td>1</td>
|
|
|
<td>页码</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>pageSize</td>
|
|
|
<td>是</td>
|
|
|
<td>10</td>
|
|
|
<td>每页记录数</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>status</td>
|
|
|
<td>否</td>
|
|
|
<td>1</td>
|
|
|
<td>分类状态</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-111">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>null</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> total</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">总记录数</span></td><td key=5></td></tr><tr key=0-2-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> records</span></td><td key=1><span>object []</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">当前页数据</span></td><td key=5><p key=3><span style="font-weight: '700'">item 类型: </span><span>object</span></p></td></tr><tr key=0-2-1-0><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> id</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-1><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> name</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-2><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> categoryId</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-3><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> price</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-4><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> image</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-5><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> description</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-6><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> status</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-7><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> updateTime</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-8><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> categoryName</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">分类名称</span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u83dcu54c1u8d77u552eu3001u505cu552e0a3ca20id3du83dcu54c1u8d77u552eu3001u505cu552e3e203ca3e">菜品起售、停售
|
|
|
<a id=菜品起售、停售> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-112">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/dish/status/{status}</p>
|
|
|
<p><strong>Method：</strong> POST</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-113">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>路径参数</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>status</td>
|
|
|
<td>1</td>
|
|
|
<td>菜品状态：1为起售，0为停售</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>Query</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>id</td>
|
|
|
<td>是</td>
|
|
|
<td>101</td>
|
|
|
<td>菜品id</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-114">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h1 id="u8ba2u5355u7ba1u7406u63a5u53e3">订单管理接口</h1>
|
|
|
<p></p>
|
|
|
<h2 id="u53d6u6d88u8ba2u53550a3ca20id3du53d6u6d88u8ba2u53553e203ca3e">取消订单
|
|
|
<a id=取消订单> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-115">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/order/cancel</p>
|
|
|
<p><strong>Method：</strong> PUT</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-116">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>Body</strong></p>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> cancelReason</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">订单取消原因</span></td><td key=5></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> id</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">订单id</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-117">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u5404u4e2au72b6u6001u7684u8ba2u5355u6570u91cfu7edfu8ba10a3ca20id3du5404u4e2au72b6u6001u7684u8ba2u5355u6570u91cfu7edfu8ba13e203ca3e">各个状态的订单数量统计
|
|
|
<a id=各个状态的订单数量统计> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-118">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/order/statistics</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-119">请求参数</h3>
|
|
|
<h3 id="-120">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> confirmed</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">待派送数量</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> deliveryInProgress</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">派送中数量</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-2><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> toBeConfirmed</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">待接单数量</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u5b8cu6210u8ba2u53550a3ca20id3du5b8cu6210u8ba2u53553e203ca3e">完成订单
|
|
|
<a id=完成订单> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-121">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/order/complete/{id}</p>
|
|
|
<p><strong>Method：</strong> PUT</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-122">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>路径参数</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>id</td>
|
|
|
<td>101</td>
|
|
|
<td>订单id</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-123">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u62d2u53550a3ca20id3du62d2u53553e203ca3e">拒单
|
|
|
<a id=拒单> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-124">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/order/rejection</p>
|
|
|
<p><strong>Method：</strong> PUT</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-125">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>Body</strong></p>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> id</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">订单id</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> rejectionReason</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">拒单原因</span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-126">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u63a5u53550a3ca20id3du63a5u53553e203ca3e">接单
|
|
|
<a id=接单> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-127">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/order/confirm</p>
|
|
|
<p><strong>Method：</strong> PUT</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-128">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>application/json</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>Body</strong></p>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> id</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">订单id</span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-129">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u67e5u8be2u8ba2u5355u8be6u60c50a3ca20id3du67e5u8be2u8ba2u5355u8be6u60c53e203ca3e">查询订单详情
|
|
|
<a id=查询订单详情> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-130">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/order/details/{id}</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-131">请求参数</h3>
|
|
|
<p><strong>路径参数</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>id</td>
|
|
|
<td>101</td>
|
|
|
<td>订单id</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-132">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> address</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> addressBookId</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-2><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> amount</span></td><td key=1><span>number</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-3><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> cancelReason</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-4><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> cancelTime</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=4><span style="font-weight: '700'">format: </span><span>date-time</span></p></td></tr><tr key=0-1-5><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> checkoutTime</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=4><span style="font-weight: '700'">format: </span><span>date-time</span></p></td></tr><tr key=0-1-6><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> consignee</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-7><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> deliveryStatus</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-8><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> deliveryTime</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=4><span style="font-weight: '700'">format: </span><span>date-time</span></p></td></tr><tr key=0-1-9><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> estimatedDeliveryTime</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=4><span style="font-weight: '700'">format: </span><span>date-time</span></p></td></tr><tr key=0-1-10><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> id</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-11><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> number</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-12><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> orderDetailList</span></td><td key=1><span>object []</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=3><span style="font-weight: '700'">item 类型: </span><span>object</span></p></td></tr><tr key=0-1-12-0><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> amount</span></td><td key=1><span>number</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-12-1><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> dishFlavor</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-12-2><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> dishId</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-12-3><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> id</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-12-4><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> image</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-12-5><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> name</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-12-6><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> number</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-12-7><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> orderId</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-12-8><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> setmealId</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-13><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> orderDishes</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-14><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> orderTime</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=4><span style="font-weight: '700'">format: </span><span>date-time</span></p></td></tr><tr key=0-1-15><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> packAmount</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-16><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> payMethod</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-17><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> payStatus</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-18><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> phone</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-19><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> rejectionReason</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-20><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> remark</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1-21><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> status</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-22><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> tablewareNumber</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-23><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> tablewareStatus</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1-24><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> userId</span></td><td key=1><span>integer</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int64</span></p></td></tr><tr key=0-1-25><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> userName</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u6d3eu9001u8ba2u53550a3ca20id3du6d3eu9001u8ba2u53553e203ca3e">派送订单
|
|
|
<a id=派送订单> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-133">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/order/delivery/{id}</p>
|
|
|
<p><strong>Method：</strong> PUT</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-134">请求参数</h3>
|
|
|
<p><strong>路径参数</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>id</td>
|
|
|
<td>101</td>
|
|
|
<td>订单id</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-135">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h2 id="u8ba2u5355u641cu7d220a3ca20id3du8ba2u5355u641cu7d223e203ca3e">订单搜索
|
|
|
<a id=订单搜索> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-136">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/order/conditionSearch</p>
|
|
|
<p><strong>Method：</strong> GET</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-137">请求参数</h3>
|
|
|
<p><strong>Query</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>beginTime</td>
|
|
|
<td>否</td>
|
|
|
<td></td>
|
|
|
<td>beginTime</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>endTime</td>
|
|
|
<td>否</td>
|
|
|
<td></td>
|
|
|
<td>endTime</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>number</td>
|
|
|
<td>否</td>
|
|
|
<td></td>
|
|
|
<td>number</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>page</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td>page</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>pageSize</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td>pageSize</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>phone</td>
|
|
|
<td>否</td>
|
|
|
<td></td>
|
|
|
<td>phone</td>
|
|
|
</tr>
|
|
|
<tr>
|
|
|
<td>status</td>
|
|
|
<td>否</td>
|
|
|
<td></td>
|
|
|
<td>status</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-138">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>null</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>object</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-0><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> total</span></td><td key=1><span>number</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1><td key=0><span style="padding-left: 20px"><span style="color: #8c8a8a">├─</span> records</span></td><td key=1><span>object []</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=3><span style="font-weight: '700'">item 类型: </span><span>object</span></p></td></tr><tr key=0-2-1-0><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> id</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-1><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> number</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-2><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> status</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-3><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> userId</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-4><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> addressBookId</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-5><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> orderTime</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-6><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> checkoutTime</span></td><td key=1><span>null,string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-7><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> payMethod</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-8><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> payStatus</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-9><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> amount</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-10><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> remark</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-11><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> userName</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-12><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> phone</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-13><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> address</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-14><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> consignee</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-15><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> cancelReason</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-16><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> rejectionReason</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-17><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> cancelTime</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-18><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> estimatedDeliveryTime</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-19><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> deliveryStatus</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-20><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> deliveryTime</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-21><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> packAmount</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-22><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> tablewareNumber</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-23><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> tablewareStatus</span></td><td key=1><span>number</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr><tr key=0-2-1-24><td key=0><span style="padding-left: 40px"><span style="color: #8c8a8a">├─</span> orderDishes</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">订单包含的菜品，以字符串形式展示</span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h1 id="u901au7528u63a5u53e3">通用接口</h1>
|
|
|
<p></p>
|
|
|
<h2 id="u6587u4ef6u4e0au4f200a3ca20id3du6587u4ef6u4e0au4f203e203ca3e">文件上传
|
|
|
<a id=文件上传> </a></h2>
|
|
|
<p></p>
|
|
|
<h3 id="-139">基本信息</h3>
|
|
|
<p><strong>Path：</strong> /admin/common/upload</p>
|
|
|
<p><strong>Method：</strong> POST</p>
|
|
|
<p><strong>接口描述：</strong></p>
|
|
|
<h3 id="-140">请求参数</h3>
|
|
|
<p><strong>Headers</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数值</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>Content-Type</td>
|
|
|
<td>multipart/form-data</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td></td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<p><strong>Body</strong></p>
|
|
|
<table>
|
|
|
<thead>
|
|
|
<tr>
|
|
|
<th>参数名称</th>
|
|
|
<th>参数类型</th>
|
|
|
<th>是否必须</th>
|
|
|
<th>示例</th>
|
|
|
<th>备注</th>
|
|
|
</tr>
|
|
|
</thead>
|
|
|
<tbody>
|
|
|
<tr>
|
|
|
<td>file</td>
|
|
|
<td>file</td>
|
|
|
<td>是</td>
|
|
|
<td></td>
|
|
|
<td>文件</td>
|
|
|
</tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
<h3 id="-141">返回数据</h3>
|
|
|
<table>
|
|
|
<thead class="ant-table-thead">
|
|
|
<tr>
|
|
|
<th key=name>名称</th><th key=type>类型</th><th key=required>是否必须</th><th key=default>默认值</th><th key=desc>备注</th><th key=sub>其他信息</th>
|
|
|
</tr>
|
|
|
</thead><tbody className="ant-table-tbody"><tr key=0-0><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> code</span></td><td key=1><span>integer</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5><p key=2><span style="font-weight: '700'">format: </span><span>int32</span></p></td></tr><tr key=0-1><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> data</span></td><td key=1><span>string</span></td><td key=2>必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap">文件上传路径</span></td><td key=5></td></tr><tr key=0-2><td key=0><span style="padding-left: 0px"><span style="color: #8c8a8a"></span> msg</span></td><td key=1><span>string</span></td><td key=2>非必须</td><td key=3></td><td key=4><span style="white-space: pre-wrap"></span></td><td key=5></td></tr>
|
|
|
</tbody>
|
|
|
</table>
|
|
|
|
|
|
<footer class="m-footer">
|
|
|
<p>Build by <a href="https://ymfe.org/">YMFE</a>.</p>
|
|
|
</footer>
|
|
|
</div>
|
|
|
</div>
|
|
|
</body>
|
|
|
</html>
|
|
|
|
