包含后厨 团餐 门店分支
25개 이상의 토픽을 선택하실 수 없습니다. Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

620 lines
14 KiB

  1. {
  2. "openapi": "3.0.1",
  3. "info": {
  4. "title": "Ant Design Pro",
  5. "version": "1.0.0"
  6. },
  7. "servers": [
  8. {
  9. "url": "http://localhost:44324/"
  10. },
  11. {
  12. "url": "https://localhost:44324/"
  13. }
  14. ],
  15. "paths": {
  16. "/kitchen/api/currentUser": {
  17. "get": {
  18. "tags": [
  19. "api"
  20. ],
  21. "description": "获取当前的用户",
  22. "operationId": "currentUser",
  23. "responses": {
  24. "200": {
  25. "description": "Success",
  26. "content": {
  27. "application/json": {
  28. "schema": {
  29. "$ref": "#/components/schemas/CurrentUser"
  30. }
  31. }
  32. }
  33. },
  34. "401": {
  35. "description": "Error",
  36. "content": {
  37. "application/json": {
  38. "schema": {
  39. "$ref": "#/components/schemas/ErrorResponse"
  40. }
  41. }
  42. }
  43. }
  44. }
  45. },
  46. "x-swagger-router-controller": "api"
  47. },
  48. "/kitchen/api/login/captcha": {
  49. "post": {
  50. "description": "发送验证码",
  51. "operationId": "getFakeCaptcha",
  52. "tags": [
  53. "login"
  54. ],
  55. "parameters": [
  56. {
  57. "name": "phone",
  58. "in": "query",
  59. "description": "手机号",
  60. "schema": {
  61. "type": "string"
  62. }
  63. }
  64. ],
  65. "responses": {
  66. "200": {
  67. "description": "Success",
  68. "content": {
  69. "application/json": {
  70. "schema": {
  71. "$ref": "#/components/schemas/FakeCaptcha"
  72. }
  73. }
  74. }
  75. }
  76. }
  77. }
  78. },
  79. "/kitchen/api/login/outLogin": {
  80. "post": {
  81. "description": "登录接口",
  82. "operationId": "outLogin",
  83. "tags": [
  84. "login"
  85. ],
  86. "responses": {
  87. "200": {
  88. "description": "Success",
  89. "content": {
  90. "application/json": {
  91. "schema": {
  92. "type": "object"
  93. }
  94. }
  95. }
  96. },
  97. "401": {
  98. "description": "Error",
  99. "content": {
  100. "application/json": {
  101. "schema": {
  102. "$ref": "#/components/schemas/ErrorResponse"
  103. }
  104. }
  105. }
  106. }
  107. }
  108. },
  109. "x-swagger-router-controller": "api"
  110. },
  111. "/kitchen/api/login/account": {
  112. "post": {
  113. "tags": [
  114. "login"
  115. ],
  116. "description": "登录接口",
  117. "operationId": "login",
  118. "requestBody": {
  119. "description": "登录系统",
  120. "content": {
  121. "application/json": {
  122. "schema": {
  123. "$ref": "#/components/schemas/LoginParams"
  124. }
  125. }
  126. },
  127. "required": true
  128. },
  129. "responses": {
  130. "200": {
  131. "description": "Success",
  132. "content": {
  133. "application/json": {
  134. "schema": {
  135. "$ref": "#/components/schemas/LoginResult"
  136. }
  137. }
  138. }
  139. },
  140. "401": {
  141. "description": "Error",
  142. "content": {
  143. "application/json": {
  144. "schema": {
  145. "$ref": "#/components/schemas/ErrorResponse"
  146. }
  147. }
  148. }
  149. }
  150. },
  151. "x-codegen-request-body-name": "body"
  152. },
  153. "x-swagger-router-controller": "api"
  154. },
  155. "/kitchen/api/notices": {
  156. "summary": "getNotices",
  157. "description": "NoticeIconItem",
  158. "get": {
  159. "tags": [
  160. "api"
  161. ],
  162. "operationId": "getNotices",
  163. "responses": {
  164. "200": {
  165. "description": "Success",
  166. "content": {
  167. "application/json": {
  168. "schema": {
  169. "$ref": "#/components/schemas/NoticeIconList"
  170. }
  171. }
  172. }
  173. }
  174. }
  175. }
  176. },
  177. "/kitchen/api/rule": {
  178. "get": {
  179. "tags": [
  180. "rule"
  181. ],
  182. "description": "获取规则列表",
  183. "operationId": "rule",
  184. "parameters": [
  185. {
  186. "name": "current",
  187. "in": "query",
  188. "description": "当前的页码",
  189. "schema": {
  190. "type": "number"
  191. }
  192. },
  193. {
  194. "name": "pageSize",
  195. "in": "query",
  196. "description": "页面的容量",
  197. "schema": {
  198. "type": "number"
  199. }
  200. }
  201. ],
  202. "responses": {
  203. "200": {
  204. "description": "Success",
  205. "content": {
  206. "application/json": {
  207. "schema": {
  208. "$ref": "#/components/schemas/RuleList"
  209. }
  210. }
  211. }
  212. },
  213. "401": {
  214. "description": "Error",
  215. "content": {
  216. "application/json": {
  217. "schema": {
  218. "$ref": "#/components/schemas/ErrorResponse"
  219. }
  220. }
  221. }
  222. }
  223. }
  224. },
  225. "post": {
  226. "tags": [
  227. "rule"
  228. ],
  229. "description": "新建规则",
  230. "operationId": "addRule",
  231. "responses": {
  232. "200": {
  233. "description": "Success",
  234. "content": {
  235. "application/json": {
  236. "schema": {
  237. "$ref": "#/components/schemas/RuleListItem"
  238. }
  239. }
  240. }
  241. },
  242. "401": {
  243. "description": "Error",
  244. "content": {
  245. "application/json": {
  246. "schema": {
  247. "$ref": "#/components/schemas/ErrorResponse"
  248. }
  249. }
  250. }
  251. }
  252. }
  253. },
  254. "put": {
  255. "tags": [
  256. "rule"
  257. ],
  258. "description": "新建规则",
  259. "operationId": "updateRule",
  260. "responses": {
  261. "200": {
  262. "description": "Success",
  263. "content": {
  264. "application/json": {
  265. "schema": {
  266. "$ref": "#/components/schemas/RuleListItem"
  267. }
  268. }
  269. }
  270. },
  271. "401": {
  272. "description": "Error",
  273. "content": {
  274. "application/json": {
  275. "schema": {
  276. "$ref": "#/components/schemas/ErrorResponse"
  277. }
  278. }
  279. }
  280. }
  281. }
  282. },
  283. "delete": {
  284. "tags": [
  285. "rule"
  286. ],
  287. "description": "删除规则",
  288. "operationId": "removeRule",
  289. "responses": {
  290. "200": {
  291. "description": "Success",
  292. "content": {
  293. "application/json": {
  294. "schema": {
  295. "type": "object"
  296. }
  297. }
  298. }
  299. },
  300. "401": {
  301. "description": "Error",
  302. "content": {
  303. "application/json": {
  304. "schema": {
  305. "$ref": "#/components/schemas/ErrorResponse"
  306. }
  307. }
  308. }
  309. }
  310. }
  311. },
  312. "x-swagger-router-controller": "api"
  313. },
  314. "/swagger": {
  315. "x-swagger-pipe": "swagger_raw"
  316. }
  317. },
  318. "components": {
  319. "schemas": {
  320. "CurrentUser": {
  321. "type": "object",
  322. "properties": {
  323. "name": {
  324. "type": "string"
  325. },
  326. "avatar": {
  327. "type": "string"
  328. },
  329. "userid": {
  330. "type": "string"
  331. },
  332. "email": {
  333. "type": "string"
  334. },
  335. "signature": {
  336. "type": "string"
  337. },
  338. "title": {
  339. "type": "string"
  340. },
  341. "group": {
  342. "type": "string"
  343. },
  344. "tags": {
  345. "type": "array",
  346. "items": {
  347. "type": "object",
  348. "properties": {
  349. "key": {
  350. "type": "string"
  351. },
  352. "label": {
  353. "type": "string"
  354. }
  355. }
  356. }
  357. },
  358. "notifyCount": {
  359. "type": "integer",
  360. "format": "int32"
  361. },
  362. "unreadCount": {
  363. "type": "integer",
  364. "format": "int32"
  365. },
  366. "country": {
  367. "type": "string"
  368. },
  369. "access": {
  370. "type": "string"
  371. },
  372. "geographic": {
  373. "type": "object",
  374. "properties": {
  375. "province": {
  376. "type": "object",
  377. "properties": {
  378. "label": {
  379. "type": "string"
  380. },
  381. "key": {
  382. "type": "string"
  383. }
  384. }
  385. },
  386. "city": {
  387. "type": "object",
  388. "properties": {
  389. "label": {
  390. "type": "string"
  391. },
  392. "key": {
  393. "type": "string"
  394. }
  395. }
  396. }
  397. }
  398. },
  399. "address": {
  400. "type": "string"
  401. },
  402. "phone": {
  403. "type": "string"
  404. }
  405. }
  406. },
  407. "LoginResult": {
  408. "type": "object",
  409. "properties": {
  410. "status": {
  411. "type": "string"
  412. },
  413. "type": {
  414. "type": "string"
  415. },
  416. "currentAuthority": {
  417. "type": "string"
  418. }
  419. }
  420. },
  421. "PageParams": {
  422. "type": "object",
  423. "properties": {
  424. "current": {
  425. "type": "number"
  426. },
  427. "pageSize": {
  428. "type": "number"
  429. }
  430. }
  431. },
  432. "RuleListItem": {
  433. "type": "object",
  434. "properties": {
  435. "key": {
  436. "type": "integer",
  437. "format": "int32"
  438. },
  439. "disabled": {
  440. "type": "boolean"
  441. },
  442. "href": {
  443. "type": "string"
  444. },
  445. "avatar": {
  446. "type": "string"
  447. },
  448. "name": {
  449. "type": "string"
  450. },
  451. "owner": {
  452. "type": "string"
  453. },
  454. "desc": {
  455. "type": "string"
  456. },
  457. "callNo": {
  458. "type": "integer",
  459. "format": "int32"
  460. },
  461. "status": {
  462. "type": "integer",
  463. "format": "int32"
  464. },
  465. "updatedAt": {
  466. "type": "string",
  467. "format": "datetime"
  468. },
  469. "createdAt": {
  470. "type": "string",
  471. "format": "datetime"
  472. },
  473. "progress": {
  474. "type": "integer",
  475. "format": "int32"
  476. }
  477. }
  478. },
  479. "RuleList": {
  480. "type": "object",
  481. "properties": {
  482. "data": {
  483. "type": "array",
  484. "items": {
  485. "$ref": "#/components/schemas/RuleListItem"
  486. }
  487. },
  488. "total": {
  489. "type": "integer",
  490. "description": "列表的内容总数",
  491. "format": "int32"
  492. },
  493. "success": {
  494. "type": "boolean"
  495. }
  496. }
  497. },
  498. "FakeCaptcha": {
  499. "type": "object",
  500. "properties": {
  501. "code": {
  502. "type": "integer",
  503. "format": "int32"
  504. },
  505. "status": {
  506. "type": "string"
  507. }
  508. }
  509. },
  510. "LoginParams": {
  511. "type": "object",
  512. "properties": {
  513. "username": {
  514. "type": "string"
  515. },
  516. "password": {
  517. "type": "string"
  518. },
  519. "autoLogin": {
  520. "type": "boolean"
  521. },
  522. "type": {
  523. "type": "string"
  524. }
  525. }
  526. },
  527. "ErrorResponse": {
  528. "required": [
  529. "errorCode"
  530. ],
  531. "type": "object",
  532. "properties": {
  533. "errorCode": {
  534. "type": "string",
  535. "description": "业务约定的错误码"
  536. },
  537. "errorMessage": {
  538. "type": "string",
  539. "description": "业务上的错误信息"
  540. },
  541. "success": {
  542. "type": "boolean",
  543. "description": "业务上的请求是否成功"
  544. }
  545. }
  546. },
  547. "NoticeIconList": {
  548. "type": "object",
  549. "properties": {
  550. "data": {
  551. "type": "array",
  552. "items": {
  553. "$ref": "#/components/schemas/NoticeIconItem"
  554. }
  555. },
  556. "total": {
  557. "type": "integer",
  558. "description": "列表的内容总数",
  559. "format": "int32"
  560. },
  561. "success": {
  562. "type": "boolean"
  563. }
  564. }
  565. },
  566. "NoticeIconItemType": {
  567. "title": "NoticeIconItemType",
  568. "description": "已读未读列表的枚举",
  569. "type": "string",
  570. "properties": {},
  571. "enum": [
  572. "notification",
  573. "message",
  574. "event"
  575. ]
  576. },
  577. "NoticeIconItem": {
  578. "type": "object",
  579. "properties": {
  580. "id": {
  581. "type": "string"
  582. },
  583. "extra": {
  584. "type": "string",
  585. "format": "any"
  586. },
  587. "key": {
  588. "type": "string"
  589. },
  590. "read": {
  591. "type": "boolean"
  592. },
  593. "avatar": {
  594. "type": "string"
  595. },
  596. "title": {
  597. "type": "string"
  598. },
  599. "status": {
  600. "type": "string"
  601. },
  602. "datetime": {
  603. "type": "string",
  604. "format": "date"
  605. },
  606. "description": {
  607. "type": "string"
  608. },
  609. "type": {
  610. "extensions": {
  611. "x-is-enum": true
  612. },
  613. "$ref": "#/components/schemas/NoticeIconItemType"
  614. }
  615. }
  616. }
  617. }
  618. }
  619. }