You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
25 lines
76 KiB
25 lines
76 KiB
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>crm-api-docs - API Documentation</title>
|
|
<style>
|
|
body { margin: 0; padding: 0; }
|
|
#opencollection-container { width: 100vw; height: 100vh; }
|
|
</style>
|
|
<link rel="stylesheet" href="https://cdn.opencollection.com/docs.css">
|
|
<script src="https://cdn.opencollection.com/docs.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="opencollection-container"></div>
|
|
<script>
|
|
const collectionData = "opencollection: 1.0.0\ninfo:\n name: crm-api-docs\nconfig:\n environments:\n - name: local\n variables:\n - name: baseUrl\n value: https://ai.itc.vip/crm-api\n - name: token\n value: ''\nitems:\n - info:\n name: system\n type: folder\n items:\n - info:\n name: roles\n type: folder\n items:\n - info:\n name: \u4FDD\u5B58\u89D2\u8272\n type: http\n seq: 2\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/system/roles/save'\n body:\n type: form-urlencoded\n data:\n - name: id\n value: ''\n - name: roleName\n value: \u9500\u552E\n - name: roleCode\n value: SALES\n - name: dataScope\n value: '1'\n - name: sort\n value: '0'\n - name: remark\n value: ''\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u4FDD\u5B58\u89D2\u8272\n `POST /api/system/roles/save`\n \u65B0\u589E\u6216\u7F16\u8F91\u89D2\u8272\uFF08id \u4E0D\u4F20\u4E3A\u65B0\u589E\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | id | string | \u5426 | - | \u89D2\u8272 ID\uFF0C\u7F16\u8F91\u65F6\u4F20 |\n | roleName | string | \u662F | - | \u89D2\u8272\u540D\u79F0 |\n | roleCode | string | \u662F | - | \u89D2\u8272\u7F16\u7801 |\n | dataScope | number | \u5426 | 1 | \u6570\u636E\u8303\u56F4 |\n | sort | number | \u5426 | 0 | \u6392\u5E8F |\n | remark | string | \u5426 | - | \u5907\u6CE8 |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/system/roles/save\n Content-Type: application/x-www-form-urlencoded\n\n id=&roleName=\u9500\u552E&roleCode=SALES&dataScope=1&sort=0&remark=\n ## \u54CD\u5E94 data \u7ED3\u6784\n null\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": null\n }\n - info:\n name: \u5206\u914D\u89D2\u8272\u83DC\u5355\n type: http\n seq: 4\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/system/roles/assign-menus'\n body:\n type: form-urlencoded\n data:\n - name: roleId\n value: '1'\n - name: menuIds\n value: 1,2,3\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u5206\u914D\u89D2\u8272\u83DC\u5355\n `POST /api/system/roles/assign-menus`\n \u4E3A\u89D2\u8272\u5168\u91CF\u91CD\u8BBE\u83DC\u5355\u6743\u9650\uFF08\u5148\u6E05\u7A7A\u518D\u5199\u5165\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | roleId | string | \u662F | - | \u89D2\u8272 ID |\n | menuIds | string | \u662F | - | \u83DC\u5355 ID \u5217\u8868\uFF0C\u9017\u53F7\u5206\u9694 |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/system/roles/assign-menus\n Content-Type: application/x-www-form-urlencoded\n\n roleId=1&menuIds=1,2,3\n ## \u54CD\u5E94 data \u7ED3\u6784\n null\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": null\n }\n - info:\n name: \u5220\u9664\u89D2\u8272\n type: http\n seq: 3\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/system/roles/delete'\n body:\n type: form-urlencoded\n data:\n - name: id\n value: '1'\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u5220\u9664\u89D2\u8272\n `POST /api/system/roles/delete`\n \u5220\u9664\u89D2\u8272\uFF08\u540C\u65F6\u6E05\u7406\u8BE5\u89D2\u8272\u7684\u83DC\u5355\u5173\u8054\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | id | string | \u662F | - | \u89D2\u8272 ID |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/system/roles/delete\n Content-Type: application/x-www-form-urlencoded\n\n id=1\n ## \u54CD\u5E94 data \u7ED3\u6784\n null\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": null\n }\n - info:\n name: \u89D2\u8272\u5206\u9875\n type: http\n seq: 1\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/system/roles/page'\n body:\n type: form-urlencoded\n data:\n - name: current\n value: '1'\n - name: size\n value: '10'\n - name: keyword\n value: ''\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u89D2\u8272\u5206\u9875\n `POST /api/system/roles/page`\n \u89D2\u8272\u5206\u9875\u67E5\u8BE2\uFF08keyword \u6309\u89D2\u8272\u540D\u6A21\u7CCA\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | current | number | \u5426 | 1 | \u9875\u7801\uFF0C\u4ECE 1 \u8D77 |\n | size | number | \u5426 | 10 | \u6BCF\u9875\u6761\u6570 |\n | keyword | string | \u5426 | - | \u89D2\u8272\u540D\u6A21\u7CCA\u5173\u952E\u8BCD |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/system/roles/page\n Content-Type: application/x-www-form-urlencoded\n\n current=1&size=10&keyword=\n ## \u54CD\u5E94 data \u7ED3\u6784\n data \u4E3A PageResult\uFF1Acontent / total / size / current / pages / empty\uFF1Bcontent \u5143\u7D20 SysRole\uFF1A\n | \u5B57\u6BB5 | \u7C7B\u578B | \u8BF4\u660E |\n | --- | --- | --- |\n | id | string | \u89D2\u8272 ID |\n | roleName | string | \u89D2\u8272\u540D\u79F0 |\n | roleCode | string | \u89D2\u8272\u7F16\u7801 |\n | dataScope | number | \u6570\u636E\u8303\u56F4 1\u672C\u4EBA 2\u672C\u90E8\u95E8 3\u672C\u90E8\u95E8\u53CA\u5B50 4\u5168\u90E8 |\n | sort | number | \u6392\u5E8F |\n | remark | string | \u5907\u6CE8 |\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": {\n \"content\": [\n {\n \"id\": \"1\",\n \"roleName\": \"\u9500\u552E\",\n \"roleCode\": \"SALES\",\n \"dataScope\": 1,\n \"sort\": 0,\n \"remark\": \"\"\n }\n ],\n \"total\": 1,\n \"size\": 10,\n \"current\": 1,\n \"pages\": 1,\n \"empty\": false\n }\n }\n - info:\n name: \u89D2\u8272\u5DF2\u6388\u6743\u83DC\u5355ID\n type: http\n seq: 5\n tags:\n - generated\n http:\n method: GET\n url: '{{baseUrl}}/api/system/roles/menus?roleId=1'\n params:\n - name: roleId\n value: '1'\n type: query\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u89D2\u8272\u5DF2\u6388\u6743\u83DC\u5355ID\n `GET /api/system/roles/menus`\n \u67E5\u8BE2\u89D2\u8272\u5DF2\u6388\u6743\u7684\u83DC\u5355 ID \u5217\u8868\uFF08\u56DE\u663E\u52FE\u9009\u7528\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | roleId | string | \u662F | - | \u89D2\u8272 ID |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n GET /api/system/roles/menus?roleId=1\n ## \u54CD\u5E94 data \u7ED3\u6784\n data \u4E3A string \u6570\u7EC4\uFF1A\u5DF2\u6388\u6743\u7684\u83DC\u5355 ID \u5217\u8868\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": [\"1\", \"2\", \"3\"]\n }\n - info:\n name: menus\n type: folder\n items:\n - info:\n name: \u4FDD\u5B58\u83DC\u5355\n type: http\n seq: 2\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/system/menus/save'\n body:\n type: form-urlencoded\n data:\n - name: id\n value: ''\n - name: parentId\n value: '0'\n - name: menuName\n value: \u5BA2\u6237\u7BA1\u7406\n - name: menuType\n value: '1'\n - name: path\n value: /customer\n - name: component\n value: ''\n - name: icon\n value: ''\n - name: sort\n value: '0'\n - name: visible\n value: 'true'\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u4FDD\u5B58\u83DC\u5355\n `POST /api/system/menus/save`\n \u65B0\u589E\u6216\u7F16\u8F91\u83DC\u5355\uFF08id \u4E0D\u4F20\u4E3A\u65B0\u589E\uFF0C\u4F20\u4E3A\u7F16\u8F91\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | id | string | \u5426 | - | \u83DC\u5355 ID\uFF0C\u7F16\u8F91\u65F6\u4F20 |\n | parentId | string | \u5426 | 0 | \u4E0A\u7EA7\u83DC\u5355 ID |\n | menuName | string | \u662F | - | \u83DC\u5355\u540D\u79F0 |\n | menuType | number | \u662F | - | 1=\u76EE\u5F55 2=\u83DC\u5355 3=\u6309\u94AE |\n | path | string | \u5426 | - | \u524D\u7AEF\u8DEF\u7531\u8DEF\u5F84 |\n | component | string | \u5426 | - | \u524D\u7AEF\u7EC4\u4EF6\u8DEF\u5F84 |\n | icon | string | \u5426 | - | \u56FE\u6807 |\n | sort | number | \u5426 | 0 | \u6392\u5E8F |\n | visible | boolean | \u5426 | true | \u662F\u5426\u53EF\u89C1 |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/system/menus/save\n Content-Type: application/x-www-form-urlencoded\n\n id=&parentId=0&menuName=\u5BA2\u6237\u7BA1\u7406&menuType=1&path=/customer&component=&icon=&sort=0&visible=true\n ## \u54CD\u5E94 data \u7ED3\u6784\n null\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": null\n }\n - info:\n name: \u5220\u9664\u83DC\u5355\n type: http\n seq: 3\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/system/menus/delete'\n body:\n type: form-urlencoded\n data:\n - name: id\n value: '1'\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u5220\u9664\u83DC\u5355\n `POST /api/system/menus/delete`\n \u5220\u9664\u83DC\u5355\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | id | string | \u662F | - | \u83DC\u5355 ID |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/system/menus/delete\n Content-Type: application/x-www-form-urlencoded\n\n id=1\n ## \u54CD\u5E94 data \u7ED3\u6784\n null\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": null\n }\n - info:\n name: \u83DC\u5355\u6811\n type: http\n seq: 1\n tags:\n - generated\n http:\n method: GET\n url: '{{baseUrl}}/api/system/menus/tree'\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u83DC\u5355\u6811\n `GET /api/system/menus/tree`\n \u5F53\u524D\u767B\u5F55\u7528\u6237\u6709\u6743\u8BBF\u95EE\u7684\u83DC\u5355\u6811\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n \u65E0\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n GET /api/system/menus/tree\n ## \u54CD\u5E94 data \u7ED3\u6784\n data \u4E3A SysMenu \u6570\u7EC4\uFF08\u6811\uFF0Cchildren \u5D4C\u5957\uFF09\uFF0C\u5143\u7D20\u5B57\u6BB5\uFF1A\n | \u5B57\u6BB5 | \u7C7B\u578B | \u8BF4\u660E |\n | --- | --- | --- |\n | id | string | \u83DC\u5355 ID |\n | parentId | string | \u4E0A\u7EA7\u83DC\u5355 ID\uFF0C\u6839\u4E3A 0 |\n | menuName | string | \u83DC\u5355\u540D\u79F0 |\n | menuType | number | \u7C7B\u578B\uFF1A1=\u76EE\u5F55 2=\u83DC\u5355 3=\u6309\u94AE |\n | path | string | \u524D\u7AEF\u8DEF\u7531\u8DEF\u5F84 |\n | component | string | \u524D\u7AEF\u7EC4\u4EF6\u8DEF\u5F84 |\n | icon | string | \u56FE\u6807 |\n | sort | number | \u6392\u5E8F |\n | visible | boolean | \u662F\u5426\u53EF\u89C1 |\n | children | array | \u5B50\u83DC\u5355 |\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": [\n {\n \"id\": \"1\",\n \"parentId\": \"0\",\n \"menuName\": \"\u5BA2\u6237\u7BA1\u7406\",\n \"menuType\": 1,\n \"path\": \"/customer\",\n \"component\": \"\",\n \"icon\": \"\",\n \"sort\": 0,\n \"visible\": true,\n \"children\": []\n }\n ]\n }\n - info:\n name: depts\n type: folder\n items:\n - info:\n name: \u4FDD\u5B58\u90E8\u95E8\n type: http\n seq: 2\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/system/depts/save'\n body:\n type: form-urlencoded\n data:\n - name: id\n value: ''\n - name: parentId\n value: '0'\n - name: deptName\n value: \u9500\u552E\u4E00\u90E8\n - name: sort\n value: '0'\n - name: leaderUserId\n value: ''\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u4FDD\u5B58\u90E8\u95E8\n `POST /api/system/depts/save`\n \u65B0\u589E\u6216\u7F16\u8F91\u90E8\u95E8\uFF08id \u4E0D\u4F20\u4E3A\u65B0\u589E\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | id | string | \u5426 | - | \u90E8\u95E8 ID\uFF0C\u7F16\u8F91\u65F6\u4F20 |\n | parentId | string | \u5426 | 0 | \u4E0A\u7EA7\u90E8\u95E8 ID |\n | deptName | string | \u662F | - | \u90E8\u95E8\u540D\u79F0 |\n | sort | number | \u5426 | 0 | \u6392\u5E8F |\n | leaderUserId | string | \u5426 | - | \u90E8\u95E8\u8D1F\u8D23\u4EBA\u7528\u6237 ID |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/system/depts/save\n Content-Type: application/x-www-form-urlencoded\n\n id=&parentId=0&deptName=\u9500\u552E\u4E00\u90E8&sort=0&leaderUserId=\n ## \u54CD\u5E94 data \u7ED3\u6784\n null\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": null\n }\n - info:\n name: \u5220\u9664\u90E8\u95E8\n type: http\n seq: 3\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/system/depts/delete'\n body:\n type: form-urlencoded\n data:\n - name: id\n value: '1'\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u5220\u9664\u90E8\u95E8\n `POST /api/system/depts/delete`\n \u5220\u9664\u90E8\u95E8\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | id | string | \u662F | - | \u90E8\u95E8 ID |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/system/depts/delete\n Content-Type: application/x-www-form-urlencoded\n\n id=1\n ## \u54CD\u5E94 data \u7ED3\u6784\n null\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": null\n }\n - info:\n name: \u90E8\u95E8\u6811\n type: http\n seq: 1\n tags:\n - generated\n http:\n method: GET\n url: '{{baseUrl}}/api/system/depts/tree'\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u90E8\u95E8\u6811\n `GET /api/system/depts/tree`\n \u5168\u91CF\u90E8\u95E8\u6811\uFF08\u6309 sort \u6392\u5E8F\uFF0Cchildren \u5D4C\u5957\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n \u65E0\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n GET /api/system/depts/tree\n ## \u54CD\u5E94 data \u7ED3\u6784\n data \u4E3A SysDept \u6570\u7EC4\uFF08\u6811\uFF09\uFF0C\u5143\u7D20\u5B57\u6BB5\uFF1A\n | \u5B57\u6BB5 | \u7C7B\u578B | \u8BF4\u660E |\n | --- | --- | --- |\n | id | string | \u90E8\u95E8 ID |\n | parentId | string | \u4E0A\u7EA7\u90E8\u95E8 ID\uFF0C\u6839\u4E3A 0 |\n | deptName | string | \u90E8\u95E8\u540D\u79F0 |\n | ancestors | string | \u7956\u7EA7\u94FE\uFF0C\u9017\u53F7\u5206\u9694\uFF08\u5197\u4F59\u6392\u67E5\u5B57\u6BB5\uFF09 |\n | sort | number | \u6392\u5E8F |\n | leaderUserId | string | \u90E8\u95E8\u8D1F\u8D23\u4EBA\u7528\u6237 ID |\n | children | array | \u5B50\u90E8\u95E8 |\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": [\n {\n \"id\": \"1\",\n \"parentId\": \"0\",\n \"deptName\": \"\u9500\u552E\u4E00\u90E8\",\n \"ancestors\": \"0\",\n \"sort\": 0,\n \"leaderUserId\": \"1\",\n \"children\": []\n }\n ]\n }\n - info:\n name: users\n type: folder\n items:\n - info:\n name: \u5206\u914D\u7528\u6237\u89D2\u8272\n type: http\n seq: 1\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/system/users/assign-roles'\n body:\n type: form-urlencoded\n data:\n - name: userId\n value: '1'\n - name: roleIds\n value: 1,2\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u5206\u914D\u7528\u6237\u89D2\u8272\n `POST /api/system/users/assign-roles`\n \u4E3A\u7528\u6237\u5168\u91CF\u91CD\u8BBE\u89D2\u8272\uFF08\u9700 ADMIN \u89D2\u8272\uFF0C\u5148\u6E05\u7A7A\u518D\u5199\u5165\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | userId | string | \u662F | - | \u7528\u6237 ID |\n | roleIds | string | \u662F | - | \u89D2\u8272 ID \u5217\u8868\uFF0C\u9017\u53F7\u5206\u9694 |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/system/users/assign-roles\n Content-Type: application/x-www-form-urlencoded\n\n userId=1&roleIds=1,2\n ## \u54CD\u5E94 data \u7ED3\u6784\n null\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": null\n }\n - info:\n name: \u5206\u914D\u7528\u6237\u90E8\u95E8\n type: http\n seq: 2\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/system/users/assign-depts'\n body:\n type: form-urlencoded\n data:\n - name: userId\n value: '1'\n - name: primaryDeptId\n value: '1'\n - name: deptIds\n value: 2,3\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u5206\u914D\u7528\u6237\u90E8\u95E8\n `POST /api/system/users/assign-depts`\n \u539F\u5B50\u8BBE\u7F6E\u7528\u6237\u7684\u4E3B\u90E8\u95E8\u4E0E\u5168\u90E8\u517C\u804C\u90E8\u95E8\uFF08\u5168\u91CF\u66FF\u6362\uFF0C\u6821\u9A8C\u4E0E\u4E8B\u52A1\u5728 Service \u5C42\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | userId | string | \u662F | - | \u7528\u6237 ID |\n | primaryDeptId | string | \u5426 | - | \u4E3B\u90E8\u95E8 ID |\n | deptIds | string | \u5426 | - | \u517C\u804C\u90E8\u95E8 ID \u5217\u8868\uFF08\u4E3B\u90E8\u95E8\u4E4B\u5916\uFF09\uFF0C\u9017\u53F7\u5206\u9694 |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/system/users/assign-depts\n Content-Type: application/x-www-form-urlencoded\n\n userId=1&primaryDeptId=1&deptIds=2,3\n ## \u54CD\u5E94 data \u7ED3\u6784\n null\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": null\n }\n - info:\n name: \u7528\u6237\u5206\u9875\n type: http\n seq: 3\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/system/users/page'\n body:\n type: json\n data: |-\n {\n \"deptId\": null,\n \"employmentStatus\": null,\n \"loginFrom\": null,\n \"loginTo\": null,\n \"current\": 1,\n \"size\": 10,\n \"keyword\": null\n }\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u7528\u6237\u5206\u9875\n `POST /api/system/users/page`\n \u7528\u6237\u5217\u8868\u5206\u9875\u67E5\u8BE2\uFF08\u9700 ADMIN \u89D2\u8272\uFF0CJSON body \u6536\u53C2 UserPageParam\uFF0C\u7EE7\u627F\u5206\u9875\u57FA\u7C7B\u5B57\u6BB5\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\uFF08JSON body\uFF09\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | deptId | string | \u5426 | - | \u90E8\u95E8ID\uFF0C\u542B\u5168\u90E8\u5B50\u5B59\uFF1Bnull=\u5168\u516C\u53F8 |\n | employmentStatus | string | \u5426 | - | active/resigned/unassigned\uFF1Bnull=\u4E0D\u9650 |\n | loginFrom | string | \u5426 | - | \u6700\u540E\u767B\u5F55\u8D77\uFF08yyyy-MM-dd\uFF09 |\n | loginTo | string | \u5426 | - | \u6700\u540E\u767B\u5F55\u8BAB\uFF08yyyy-MM-dd\uFF09 |\n | current | number | \u5426 | 1 | \u9875\u7801\uFF08BaseParam \u5206\u9875\u5B57\u6BB5\uFF09 |\n | size | number | \u5426 | 10 | \u6BCF\u9875\u6761\u6570\uFF08BaseParam \u5206\u9875\u5B57\u6BB5\uFF09 |\n | keyword | string | \u5426 | - | \u5173\u952E\u8BCD\uFF08BaseParam \u5206\u9875\u5B57\u6BB5\uFF09 |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/system/users/page\n Content-Type: application/json\n\n {\n \"deptId\": null,\n \"employmentStatus\": \"active\",\n \"loginFrom\": null,\n \"loginTo\": null,\n \"current\": 1,\n \"size\": 10,\n \"keyword\": null\n }\n ## \u54CD\u5E94 data \u7ED3\u6784\n data \u4E3A PageResult\uFF1Acontent / total / size / current / pages / empty\uFF1Bcontent \u5143\u7D20 UserListDTO\uFF1A\n | \u5B57\u6BB5 | \u7C7B\u578B | \u8BF4\u660E |\n | --- | --- | --- |\n | id | string | \u7528\u6237ID |\n | username | string | \u59D3\u540D |\n | account | string | \u767B\u5F55\u8D26\u53F7\uFF08OA \u6765\u6E90\uFF0C\u53EA\u8BFB\uFF09 |\n | title | string | \u804C\u52A1\uFF08OA \u6765\u6E90\uFF0C\u53EA\u8BFB\uFF09 |\n | mobile | string | \u624B\u673A\u53F7 |\n | primaryDeptId | string | \u4E3B\u90E8\u95E8ID |\n | primaryDeptName | string | \u4E3B\u90E8\u95E8\u540D |\n | partTimeDepts | array | \u517C\u804C\u90E8\u95E8 [{id,name}] |\n | employmentStatus | string | \u5728\u804C\u72B6\u6001 active/resigned |\n | enabled | boolean | \u8D26\u53F7\u662F\u5426\u542F\u7528 |\n | roles | array | \u6240\u6301\u89D2\u8272 [{id,name}] |\n | lastLoginTime | string | \u6700\u540E\u767B\u5F55\u65F6\u95F4\uFF0Cnull=\u4ECE\u672A\u767B\u5F55 |\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": {\n \"content\": [\n {\n \"id\": \"1\",\n \"username\": \"\u5F20\u4E09\",\n \"account\": \"zhangsan\",\n \"title\": \"\u9500\u552E\u7ECF\u7406\",\n \"mobile\": \"13800000000\",\n \"primaryDeptId\": \"1\",\n \"primaryDeptName\": \"\u9500\u552E\u4E00\u90E8\",\n \"partTimeDepts\": [{ \"id\": \"2\", \"name\": \"\u5E02\u573A\u90E8\" }],\n \"employmentStatus\": \"active\",\n \"enabled\": true,\n \"roles\": [{ \"id\": \"1\", \"name\": \"\u9500\u552E\" }],\n \"lastLoginTime\": \"2024-01-01 12:00:00\"\n }\n ],\n \"total\": 1,\n \"size\": 10,\n \"current\": 1,\n \"pages\": 1,\n \"empty\": false\n }\n }\n - info:\n name: \u7528\u6237\u7EDF\u8BA1\n type: http\n seq: 4\n tags:\n - generated\n http:\n method: GET\n url: '{{baseUrl}}/api/system/users/stats?deptId=1'\n params:\n - name: deptId\n value: '1'\n type: query\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u7528\u6237\u7EDF\u8BA1\n `GET /api/system/users/stats`\n \u56DB\u6307\u6807\u5361\u7EDF\u8BA1\uFF08\u9700 ADMIN \u89D2\u8272\uFF0C\u53E3\u5F84\u8DDF\u968F\u9009\u4E2D\u90E8\u95E8\u5B50\u6811\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | deptId | string | \u5426 | - | \u90E8\u95E8ID\uFF08\u542B\u5B50\u5B59\uFF09\uFF1B\u4E0D\u4F20=\u5168\u516C\u53F8 |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n GET /api/system/users/stats?deptId=1\n ## \u54CD\u5E94 data \u7ED3\u6784\n | \u5B57\u6BB5 | \u7C7B\u578B | \u8BF4\u660E |\n | --- | --- | --- |\n | deptCount | number | \u90E8\u95E8\u6570\uFF08\u9009\u4E2D\u8282\u70B9\u53CA\u5176\u5B50\u5B59\uFF09 |\n | activeCount | number | \u5728\u804C\u7528\u6237\u6570 |\n | resignedCount | number | \u79BB\u804C\u7528\u6237\u6570 |\n | unassignedCount | number | \u5F85\u5206\u914D\u7528\u6237\u6570\uFF08\u5728\u804C\u4E14\u65E0\u89D2\u8272\uFF09 |\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": {\n \"deptCount\": 1,\n \"activeCount\": 1,\n \"resignedCount\": 0,\n \"unassignedCount\": 0\n }\n }\n - info:\n name: \u6743\u9650\u70B9\u7BA1\u7406\n type: folder\n items:\n - info:\n name: \u4E0A\u4F20\u56FE\u6807\n type: http\n seq: 4\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/resources/icon/upload'\n body:\n type: multipart-form\n data:\n - name: file\n type: file\n value: []\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u4E0A\u4F20\u56FE\u6807\n `POST /api/resources/icon/upload`\n \u4E0A\u4F20\u56FE\u6807\uFF08\u9700 ADMIN \u89D2\u8272\uFF0C\u542B\u683C\u5F0F/\u5927\u5C0F\u6821\u9A8C\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | file | file | \u662F | - | \u56FE\u6807\u6587\u4EF6\uFF08multipart\uFF09 |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/resources/icon/upload\n Content-Type: multipart/form-data\n\n file=@\u672C\u5730\u56FE\u6807\u6587\u4EF6\n ## \u54CD\u5E94 data \u7ED3\u6784\n | \u5B57\u6BB5 | \u7C7B\u578B | \u8BF4\u660E |\n | --- | --- | --- |\n | fileId | string | \u6587\u4EF6\u552F\u4E00\u5F15\u7528\u51ED\u636E |\n | originalName | string | \u539F\u59CB\u6587\u4EF6\u540D |\n | size | number | \u6587\u4EF6\u5927\u5C0F\uFF08\u5B57\u8282\uFF09 |\n | contentType | string | MIME \u7C7B\u578B |\n | bizDomain | string | \u4E1A\u52A1\u57DF |\n | creatorId | string | \u4E0A\u4F20\u8005 |\n | createTime | string | \u4E0A\u4F20\u65F6\u95F4 |\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": {\n \"fileId\": \"1\",\n \"originalName\": \"icon.png\",\n \"size\": 2048,\n \"contentType\": \"image/png\",\n \"bizDomain\": \"resource-icon\",\n \"creatorId\": \"1\",\n \"createTime\": \"2024-01-01 12:00:00\"\n }\n }\n - info:\n name: \u5220\u9664\u8282\u70B9\n type: http\n seq: 3\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/resources/delete'\n body:\n type: form-urlencoded\n data:\n - name: id\n value: '1'\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u5220\u9664\u8282\u70B9\n `POST /api/resources/delete`\n \u5220\u9664\u4E00\u7EA7\u83DC\u5355/\u4E8C\u7EA7\u83DC\u5355/\u6743\u9650\u70B9\uFF08\u9700 ADMIN \u89D2\u8272\uFF0C\u542B\u5B50\u8282\u70B9\u68C0\u67E5 + \u7EA7\u8054\u6E05\u7406\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | id | string | \u662F | - | \u8282\u70B9 ID |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/resources/delete\n Content-Type: application/x-www-form-urlencoded\n\n id=1\n ## \u54CD\u5E94 data \u7ED3\u6784\n null\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": null\n }\n - info:\n name: \u65B0\u589E\u7F16\u8F91\u8282\u70B9\n type: http\n seq: 2\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/resources/saveOrUpdate'\n body:\n type: form-urlencoded\n data:\n - name: id\n value: ''\n - name: parentId\n value: '0'\n - name: name\n value: \u5BA2\u6237\u5217\u8868\n - name: type\n value: MENU\n - name: sort\n value: '1'\n - name: description\n value: ''\n - name: route\n value: /customer/list\n - name: perms\n value: ''\n - name: denyBehavior\n value: ''\n - name: apiUrl\n value: ''\n - name: status\n value: enabled\n - name: icon\n value: ''\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u65B0\u589E\u7F16\u8F91\u8282\u70B9\n `POST /api/resources/saveOrUpdate`\n \u65B0\u589E\u7F16\u8F91\u4E00\u7EA7\u83DC\u5355/\u4E8C\u7EA7\u83DC\u5355/\u6743\u9650\u70B9\uFF08\u9700 ADMIN \u89D2\u8272\uFF0C\u542B\u6821\u9A8C\uFF09\u3002\u65B0\u589E\u65F6 id \u4E0D\u4F20\u3001\u7F16\u8F91\u65F6 id \u5FC5\u4F20\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | id | string | \u5426 | - | \u8282\u70B9 ID\uFF0C\u7F16\u8F91\u65F6\u5FC5\u4F20 |\n | parentId | string | \u5426 | 0 | \u7236\u8282\u70B9 ID\uFF0C\u6839\u8282\u70B9\u4F20 null/0 |\n | name | string | \u662F | - | \u8282\u70B9\u540D\u79F0 |\n | type | string | \u662F | - | \u8282\u70B9\u7C7B\u578B CATALOG/MENU/BUTTON |\n | sort | number | \u5426 | - | \u6392\u5E8F |\n | description | string | \u5426 | - | \u63CF\u8FF0/\u5907\u6CE8 |\n | route | string | \u5426 | - | \u524D\u7AEF\u8DEF\u7531\uFF0Cmenu \u5FC5\u586B |\n | perms | string | \u5426 | - | \u6743\u9650\u7801\uFF0Cbutton \u5FC5\u586B |\n | denyBehavior | string | \u5426 | - | hide/disable\uFF0Cbutton \u5FC5\u586B |\n | apiUrl | string | \u5426 | - | \u63A5\u53E3 URL\uFF0Cbutton \u5FC5\u586B |\n | status | string | \u5426 | - | enabled/disabled |\n | icon | string | \u5426 | - | \u56FE\u6807 URL |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/resources/saveOrUpdate\n Content-Type: application/x-www-form-urlencoded\n\n id=&parentId=0&name=\u5BA2\u6237\u5217\u8868&type=MENU&sort=1&description=&route=/customer/list&perms=&denyBehavior=&apiUrl=&status=enabled&icon=\n ## \u54CD\u5E94 data \u7ED3\u6784\n data \u4E3A\u4FDD\u5B58\u540E\u7684 ResourceNode\uFF08\u5B57\u6BB5\u540C\u300C\u83B7\u53D6\u6743\u9650\u8D44\u6E90\u6811\u300D\u7684\u5143\u7D20\uFF09\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": {\n \"id\": \"1\",\n \"parentId\": \"0\",\n \"name\": \"\u5BA2\u6237\u5217\u8868\",\n \"type\": \"MENU\",\n \"sort\": 1,\n \"description\": \"\",\n \"route\": \"/customer/list\",\n \"perms\": \"\",\n \"denyBehavior\": \"\",\n \"apiUrl\": \"\",\n \"status\": \"enabled\",\n \"icon\": \"\",\n \"children\": null\n }\n }\n - info:\n name: \u83B7\u53D6\u6743\u9650\u8D44\u6E90\u6811\n type: http\n seq: 1\n tags:\n - generated\n http:\n method: GET\n url: '{{baseUrl}}/api/resources/list'\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u83B7\u53D6\u6743\u9650\u8D44\u6E90\u6811\n `GET /api/resources/list`\n \u83B7\u53D6\u6743\u9650\u8D44\u6E90\u6811\uFF08\u9700 ADMIN \u89D2\u8272\uFF09\u3002\u8FD4\u56DE\u6241\u5E73\u6570\u7EC4\uFF0C\u524D\u7AEF\u6309 parentId \u7EC4\u6811\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n \u65E0\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n GET /api/resources/list\n ## \u54CD\u5E94 data \u7ED3\u6784\n data \u4E3A ResourceNode \u6570\u7EC4\uFF0C\u5143\u7D20\u5B57\u6BB5\uFF1A\n | \u5B57\u6BB5 | \u7C7B\u578B | \u8BF4\u660E |\n | --- | --- | --- |\n | id | string | \u8282\u70B9 ID |\n | parentId | string | \u7236\u8282\u70B9 ID\uFF0C\u6839\u8282\u70B9\u4E3A null/0 |\n | name | string | \u8282\u70B9\u540D\u79F0 |\n | type | string | \u8282\u70B9\u7C7B\u578B\uFF08CATALOG/MENU/BUTTON\uFF09 |\n | sort | number | \u6392\u5E8F |\n | description | string | \u63CF\u8FF0/\u5907\u6CE8 |\n | route | string | \u524D\u7AEF\u8DEF\u7531\u8DEF\u5F84\uFF0Cmenu \u5FC5\u586B |\n | perms | string | \u6743\u9650\u7801\uFF08\u5982 crm:user:list\uFF09\uFF0Cbutton \u5FC5\u586B |\n | denyBehavior | string | \u65E0\u6743\u9650\u884C\u4E3A\uFF1Ahide / disable |\n | apiUrl | string | \u63A5\u53E3 URL\uFF0Cbutton \u5FC5\u586B |\n | status | string | \u6743\u9650\u70B9\u72B6\u6001\uFF1Aenabled / disabled |\n | icon | string | \u56FE\u6807 URL |\n | children | array | \u5B50\u8282\u70B9\u5217\u8868\uFF08\u4EC5 listAll \u8FD4\u56DE\u65F6\u586B\u5145\uFF09 |\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": [\n {\n \"id\": \"1\",\n \"parentId\": \"0\",\n \"name\": \"\u5BA2\u6237\u5217\u8868\",\n \"type\": \"MENU\",\n \"sort\": 1,\n \"description\": \"\",\n \"route\": \"/customer/list\",\n \"perms\": \"crm:customer:list\",\n \"denyBehavior\": \"hide\",\n \"apiUrl\": \"/api/customer/customers/page\",\n \"status\": \"enabled\",\n \"icon\": \"https://example.com/icon.png\",\n \"children\": []\n }\n ]\n }\n - info:\n name: \u767B\u5F55\n type: folder\n items:\n - info:\n name: \u6CE8\u9500\n type: http\n seq: 2\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/auth/logout'\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u6CE8\u9500\n `POST /api/auth/logout`\n \u6CE8\u9500\u5F53\u524D\u767B\u5F55\u6001\uFF08\u670D\u52A1\u7AEF\u6309 Authorization \u5934\u4E2D\u7684 token \u5931\u6548\u5BF9\u5E94\u767B\u5F55\u6001\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n \u65E0\uFF08token \u4ECE Authorization \u5934\u8BFB\u53D6\uFF09\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/auth/logout\n ## \u54CD\u5E94 data \u7ED3\u6784\n null\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": null\n }\n - info:\n name: \u83B7\u53D6\u5F53\u524D\u767B\u5F55\u7528\u6237\u4FE1\u606F\n type: http\n seq: 3\n tags:\n - generated\n http:\n method: GET\n url: '{{baseUrl}}/api/auth/me'\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u83B7\u53D6\u5F53\u524D\u767B\u5F55\u7528\u6237\u4FE1\u606F\n `GET /api/auth/me`\n \u83B7\u53D6\u5F53\u524D\u767B\u5F55\u7528\u6237\u4FE1\u606F\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n \u65E0\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n GET /api/auth/me\n ## \u54CD\u5E94 data \u7ED3\u6784\n | \u5B57\u6BB5 | \u7C7B\u578B | \u8BF4\u660E |\n | --- | --- | --- |\n | id | string | \u7528\u6237ID |\n | username | string | \u7528\u6237\u663E\u793A\u540D |\n | mobile | string | \u624B\u673A\u53F7 |\n | email | string | \u90AE\u7BB1 |\n | avatar | string | \u5934\u50CFURL |\n | deptId | string | \u5F52\u5C5E\u90E8\u95E8ID |\n | deptName | string | \u5F52\u5C5E\u90E8\u95E8\u540D\u79F0 |\n | menus | array | \u5F53\u524D\u7528\u6237\u83DC\u5355\u6811\uFF08\u4EC5\u767B\u5F55\u548C /me \u65F6\u586B\u5145\uFF09 |\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": {\n \"id\": \"1\",\n \"username\": \"\u5F20\u4E09\",\n \"mobile\": \"13800000000\",\n \"email\": \"zhangsan@example.com\",\n \"avatar\": \"https://example.com/avatar.png\",\n \"deptId\": \"1\",\n \"deptName\": \"\u9500\u552E\u4E00\u90E8\",\n \"menus\": []\n }\n }\n - info:\n name: \u9489\u9489\u767B\u5F55\n type: http\n seq: 1\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/auth/login/dingtalk'\n body:\n type: form-urlencoded\n data:\n - name: authCode\n value: \u4ECE\u9489\u9489\u626B\u7801/\u514D\u767B\u56DE\u8C03\u62FF\u5230\u7684\u4E34\u65F6\u6388\u6743\u7801\n runtime:\n scripts:\n - type: after-response\n code: |-\n if (res.body && res.body.success) {\n bru.setEnvVar(\"token\", res.body.data.token);\n }\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u9489\u9489\u767B\u5F55\n `POST /api/auth/login/dingtalk`\n \u9489\u9489\u767B\u5F55\uFF08\u626B\u7801/\u514D\u767B\u901A\u7528\uFF09\u3002\u6210\u529F\u540E\u81EA\u52A8\u628A data.token \u5199\u5165\u73AF\u5883\u53D8\u91CF token\uFF0C\u5176\u4F59\u63A5\u53E3\u5373\u53EF\u7EE7\u627F\u9274\u6743\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | authCode | string | \u662F | - | \u9489\u9489\u6388\u6743\u4E34\u65F6\u7801 |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1A\u65E0\u9700\u9274\u6743\n POST /api/auth/login/dingtalk\n Content-Type: application/x-www-form-urlencoded\n\n authCode=\u4ECE\u9489\u9489\u626B\u7801/\u514D\u767B\u56DE\u8C03\u62FF\u5230\u7684\u4E34\u65F6\u6388\u6743\u7801\n ## \u54CD\u5E94 data \u7ED3\u6784\n | \u5B57\u6BB5 | \u7C7B\u578B | \u8BF4\u660E |\n | --- | --- | --- |\n | token | string | JWT\uFF0C\u540E\u7EED\u8BF7\u6C42\u653E\u5165 Authorization: Bearer {token} |\n | userInfo | object | \u7528\u6237\u4FE1\u606F\uFF08\u7ED3\u6784\u89C1\u300C\u83B7\u53D6\u5F53\u524D\u767B\u5F55\u7528\u6237\u4FE1\u606F\u300D\uFF09 |\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": {\n \"token\": \"eyJhbGciOiJIUzI1NiJ9.xxx.yyy\",\n \"userInfo\": {\n \"id\": \"1\",\n \"username\": \"\u5F20\u4E09\",\n \"mobile\": \"13800000000\",\n \"email\": \"zhangsan@example.com\",\n \"avatar\": \"https://example.com/avatar.png\",\n \"deptId\": \"1\",\n \"deptName\": \"\u9500\u552E\u4E00\u90E8\",\n \"menus\": []\n }\n }\n }\n - info:\n name: \u6587\u4EF6\n type: folder\n items:\n - info:\n name: \u4E0B\u8F7D\n type: http\n seq: 3\n tags:\n - generated\n http:\n method: GET\n url: '{{baseUrl}}/api/file/download?fileId=1'\n params:\n - name: fileId\n value: '1'\n type: query\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u4E0B\u8F7D\n `GET /api/file/download`\n \u4E0B\u8F7D\uFF08\u4FE1\u5C01\u4F8B\u5916\uFF1A\u6210\u529F\u8FD4\u56DE\u4E8C\u8FDB\u5236\u6D41 + Content-Disposition \u9644\u4EF6\u5934\uFF1B\u5931\u8D25\u4ECD\u8FD4\u56DE JSON \u4FE1\u5C01\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | fileId | string | \u662F | - | \u6587\u4EF6 ID |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n GET /api/file/download?fileId=1\n ## \u54CD\u5E94 data \u7ED3\u6784\n \u6210\u529F\u4E3A\u4E8C\u8FDB\u5236\u6587\u4EF6\u6D41\uFF08\u975E\u4FE1\u5C01\uFF09\uFF1B\u5931\u8D25\u4E3A\u6807\u51C6 JSON \u4FE1\u5C01\n ## \u54CD\u5E94\u793A\u4F8B\n \u8BE5\u63A5\u53E3\u4E0D\u5957\u7EDF\u4E00\u4FE1\u5C01\uFF1A\u6210\u529F\u8FD4\u56DE\u4E8C\u8FDB\u5236\u6587\u4EF6\u6D41\uFF08Content-Disposition \u9644\u4EF6\u4E0B\u8F7D\uFF0C\u6587\u4EF6\u540D RFC 5987 \u7F16\u7801\uFF09\uFF1B\u5931\u8D25\u8FD4\u56DE\u6807\u51C6 JSON \u4FE1\u5C01\u3002\n - info:\n name: \u5206\u7247\u4E0A\u4F20-complete\n type: http\n seq: 8\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/file/multipart/complete'\n body:\n type: form-urlencoded\n data:\n - name: uploadId\n value: \u4ECE init \u8FD4\u56DE\u62FF\u5230\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u5206\u7247\u4E0A\u4F20-complete\n `POST /api/file/multipart/complete`\n \u5206\u7247\u4E0A\u4F20-complete\uFF08\u5408\u5E76\u5E76\u8FD4\u56DE\u6587\u4EF6\u8BE6\u60C5\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | uploadId | string | \u662F | - | init \u8FD4\u56DE\u7684\u4F1A\u8BDD\u6807\u8BC6 |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/file/multipart/complete\n Content-Type: application/x-www-form-urlencoded\n\n uploadId=up_1\n ## \u54CD\u5E94 data \u7ED3\u6784\n | \u5B57\u6BB5 | \u7C7B\u578B | \u8BF4\u660E |\n | --- | --- | --- |\n | fileId | string | \u6587\u4EF6\u552F\u4E00\u5F15\u7528\u51ED\u636E |\n | originalName | string | \u539F\u59CB\u6587\u4EF6\u540D |\n | size | number | \u6587\u4EF6\u5927\u5C0F\uFF08\u5B57\u8282\uFF09 |\n | contentType | string | MIME \u7C7B\u578B |\n | bizDomain | string | \u4E1A\u52A1\u57DF |\n | creatorId | string | \u4E0A\u4F20\u8005 |\n | createTime | string | \u4E0A\u4F20\u65F6\u95F4 |\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": {\n \"fileId\": \"1\",\n \"originalName\": \"bigfile.zip\",\n \"size\": 104857600,\n \"contentType\": \"application/zip\",\n \"bizDomain\": \"crm-common\",\n \"creatorId\": \"1\",\n \"createTime\": \"2024-01-01 12:00:00\"\n }\n }\n - info:\n name: \u5206\u7247\u4E0A\u4F20-init\n type: http\n seq: 6\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/file/multipart/init'\n body:\n type: form-urlencoded\n data:\n - name: originalName\n value: bigfile.zip\n - name: totalSize\n value: '104857600'\n - name: bizDomain\n value: crm-common\n - name: uploadId\n value: ''\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u5206\u7247\u4E0A\u4F20-init\n `POST /api/file/multipart/init`\n \u5206\u7247\u4E0A\u4F20-init\uFF08\u5E26 uploadId \u4E3A\u65AD\u70B9\u7EED\u4F20\uFF0C\u8FD4\u56DE\u5DF2\u4E0A\u4F20\u5206\u7247\u5E8F\u53F7\u5217\u8868\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | originalName | string | \u662F | - | \u539F\u59CB\u6587\u4EF6\u540D |\n | totalSize | number | \u662F | - | \u6587\u4EF6\u603B\u5927\u5C0F\uFF08\u5B57\u8282\uFF09 |\n | bizDomain | string | \u662F | - | \u4E1A\u52A1\u57DF |\n | uploadId | string | \u5426 | - | \u4F20\u5165\u5219\u4E3A\u65AD\u70B9\u7EED\u4F20 |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/file/multipart/init\n Content-Type: application/x-www-form-urlencoded\n\n originalName=bigfile.zip&totalSize=104857600&bizDomain=crm-common&uploadId=\n ## \u54CD\u5E94 data \u7ED3\u6784\n | \u5B57\u6BB5 | \u7C7B\u578B | \u8BF4\u660E |\n | --- | --- | --- |\n | uploadId | string | \u4E0A\u4F20\u4F1A\u8BDD\u6807\u8BC6\uFF0C\u540E\u7EED upload/complete \u51ED\u5B83 |\n | chunkSize | number | \u5206\u7247\u5927\u5C0F\uFF08\u5B57\u8282\uFF09\uFF0C\u9664\u672B\u7247\u5916\u6BCF\u7247\u5FC5\u987B\u4E3A\u6B64\u503C |\n | totalChunks | number | \u603B\u7247\u6570 |\n | uploadedChunks | array | \u5DF2\u4E0A\u4F20\u5206\u7247\u5E8F\u53F7\u5217\u8868\uFF081 \u8D77\uFF09\uFF0C\u65B0\u4F1A\u8BDD\u4E3A\u7A7A |\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": {\n \"uploadId\": \"up_1\",\n \"chunkSize\": 5242880,\n \"totalChunks\": 20,\n \"uploadedChunks\": [1]\n }\n }\n - info:\n name: \u5206\u7247\u4E0A\u4F20-\u4E0A\u4F20\u5355\u7247\n type: http\n seq: 7\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/file/multipart/upload'\n body:\n type: multipart-form\n data:\n - name: uploadId\n type: text\n value: \u4ECE init \u8FD4\u56DE\u62FF\u5230\n - name: chunkNo\n type: text\n value: '1'\n - name: file\n type: file\n value: []\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u5206\u7247\u4E0A\u4F20-\u4E0A\u4F20\u5355\u7247\n `POST /api/file/multipart/upload`\n \u5206\u7247\u4E0A\u4F20-\u4E0A\u4F20\u5355\u7247\uFF08\u5E8F\u53F7 1 \u8D77\uFF0C\u975E\u672B\u7247\u5927\u5C0F\u5FC5\u987B\u7B49\u4E8E init \u4E0B\u53D1\u7684\u5206\u7247\u5927\u5C0F\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | uploadId | string | \u662F | - | init \u8FD4\u56DE\u7684\u4F1A\u8BDD\u6807\u8BC6 |\n | chunkNo | number | \u662F | - | \u5206\u7247\u5E8F\u53F7\uFF0C\u4ECE 1 \u8D77 |\n | file | file | \u662F | - | \u5206\u7247\u4E8C\u8FDB\u5236\uFF08multipart\uFF09 |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/file/multipart/upload\n Content-Type: multipart/form-data\n\n uploadId=up_1\n chunkNo=1\n file=@\u5206\u7247\u6587\u4EF6\n ## \u54CD\u5E94 data \u7ED3\u6784\n null\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": null\n }\n - info:\n name: \u5220\u9664\u6587\u4EF6\n type: http\n seq: 5\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/file/delete'\n body:\n type: form-urlencoded\n data:\n - name: fileId\n value: '1'\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u5220\u9664\u6587\u4EF6\n `POST /api/file/delete`\n \u5220\u9664\uFF08\u903B\u8F91\u5220\u9664\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | fileId | string | \u662F | - | \u6587\u4EF6 ID |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/file/delete\n Content-Type: application/x-www-form-urlencoded\n\n fileId=1\n ## \u54CD\u5E94 data \u7ED3\u6784\n null\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": null\n }\n - info:\n name: \u6587\u4EF6\u8BE6\u60C5\n type: http\n seq: 2\n tags:\n - generated\n http:\n method: GET\n url: '{{baseUrl}}/api/file/info?fileId=1'\n params:\n - name: fileId\n value: '1'\n type: query\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u6587\u4EF6\u8BE6\u60C5\n `GET /api/file/info`\n \u6587\u4EF6\u8BE6\u60C5\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | fileId | string | \u662F | - | \u6587\u4EF6 ID |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n GET /api/file/info?fileId=1\n ## \u54CD\u5E94 data \u7ED3\u6784\n | \u5B57\u6BB5 | \u7C7B\u578B | \u8BF4\u660E |\n | --- | --- | --- |\n | fileId | string | \u6587\u4EF6\u552F\u4E00\u5F15\u7528\u51ED\u636E |\n | originalName | string | \u539F\u59CB\u6587\u4EF6\u540D |\n | size | number | \u6587\u4EF6\u5927\u5C0F\uFF08\u5B57\u8282\uFF09 |\n | contentType | string | MIME \u7C7B\u578B |\n | bizDomain | string | \u4E1A\u52A1\u57DF |\n | creatorId | string | \u4E0A\u4F20\u8005 |\n | createTime | string | \u4E0A\u4F20\u65F6\u95F4 |\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": {\n \"fileId\": \"1\",\n \"originalName\": \"contract.pdf\",\n \"size\": 102400,\n \"contentType\": \"application/pdf\",\n \"bizDomain\": \"crm-common\",\n \"creatorId\": \"1\",\n \"createTime\": \"2024-01-01 12:00:00\"\n }\n }\n - info:\n name: \u76F4\u4F20\n type: http\n seq: 1\n tags:\n - generated\n http:\n method: POST\n url: '{{baseUrl}}/api/file/upload'\n body:\n type: multipart-form\n data:\n - name: file\n type: file\n value: []\n - name: bizDomain\n type: text\n value: crm-common\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u76F4\u4F20\n `POST /api/file/upload`\n \u76F4\u4F20\uFF08\u5C0F\u6587\u4EF6\uFF0C\u8D85\u76F4\u4F20\u4E0A\u9650\u8BF7\u8D70\u5206\u7247\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | file | file | \u662F | - | \u6587\u4EF6\uFF08multipart\uFF09 |\n | bizDomain | string | \u662F | - | \u4E1A\u52A1\u57DF |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n POST /api/file/upload\n Content-Type: multipart/form-data\n\n file=@\u672C\u5730\u6587\u4EF6\n bizDomain=crm-common\n ## \u54CD\u5E94 data \u7ED3\u6784\n | \u5B57\u6BB5 | \u7C7B\u578B | \u8BF4\u660E |\n | --- | --- | --- |\n | fileId | string | \u6587\u4EF6\u552F\u4E00\u5F15\u7528\u51ED\u636E |\n | originalName | string | \u539F\u59CB\u6587\u4EF6\u540D |\n | size | number | \u6587\u4EF6\u5927\u5C0F\uFF08\u5B57\u8282\uFF09 |\n | contentType | string | MIME \u7C7B\u578B |\n | bizDomain | string | \u4E1A\u52A1\u57DF |\n | creatorId | string | \u4E0A\u4F20\u8005\uFF08\u5185\u90E8\u4E0A\u4F20\u4E3A null\uFF09 |\n | createTime | string | \u4E0A\u4F20\u65F6\u95F4 |\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": {\n \"fileId\": \"1\",\n \"originalName\": \"contract.pdf\",\n \"size\": 102400,\n \"contentType\": \"application/pdf\",\n \"bizDomain\": \"crm-common\",\n \"creatorId\": \"1\",\n \"createTime\": \"2024-01-01 12:00:00\"\n }\n }\n - info:\n name: \u9884\u89C8\u5730\u5740\n type: http\n seq: 4\n tags:\n - generated\n http:\n method: GET\n url: '{{baseUrl}}/api/file/preview-url?fileId=1'\n params:\n - name: fileId\n value: '1'\n type: query\n auth: inherit\n settings:\n encodeUrl: true\n timeout: 0\n followRedirects: true\n maxRedirects: 5\n docs: |-\n # \u9884\u89C8\u5730\u5740\n `GET /api/file/preview-url`\n \u9884\u89C8\u5730\u5740\uFF08\u53EF\u76F4\u63A5 window.open\uFF0C\u7531 kkFileView \u6E32\u67D3\uFF09\u3002\n ## \u8BF7\u6C42\u53C2\u6570\n | \u53C2\u6570 | \u7C7B\u578B | \u5FC5\u586B | \u9ED8\u8BA4 | \u8BF4\u660E |\n | --- | --- | --- | --- | --- |\n | fileId | string | \u662F | - | \u6587\u4EF6 ID |\n ## \u8BF7\u6C42\u793A\u4F8B\n \u8BF7\u6C42\u5934\uFF1AAuthorization: Bearer {{token}}\n GET /api/file/preview-url?fileId=1\n ## \u54CD\u5E94 data \u7ED3\u6784\n data \u4E3A string\uFF1A\u53EF\u76F4\u63A5\u6253\u5F00\u7684\u9884\u89C8 URL\n ## \u54CD\u5E94\u793A\u4F8B\n // \u793A\u4F8B\u6570\u636E\uFF0C\u5B57\u6BB5\u7ED3\u6784\u4EE5\u4E0A\u8868\u4E3A\u51C6\uFF0C\u975E\u771F\u5B9E\u8FD4\u56DE\n {\n \"code\": 0,\n \"success\": true,\n \"message\": \"success\",\n \"data\": \"https://kkfileview.example.com/onlinePreview?url=xxx\"\n }\nrequest:\n auth:\n type: bearer\n token: '{{token}}'\ndocs:\n content: |-\n # CRM \u63A5\u53E3\u5168\u5C40\u5951\u7EA6\n\n \u5B8C\u6574\u5951\u7EA6\u89C1 crm-core \u4ED3\u5E93\u6839\u76EE\u5F55 API_CONTRACT.md\uFF0C\u6B64\u5904\u4E3A\u4F7F\u7528\u6458\u8981\u3002\n\n ## \u4F7F\u7528\u65B9\u5F0F\n\n 1. \u9009\u62E9\u73AF\u5883\uFF08local\uFF09\uFF0C\u8FD0\u884C `auth/\u9489\u9489\u626B\u7801\u767B\u5F55`\uFF0Ctoken \u81EA\u52A8\u5199\u5165\u73AF\u5883\u53D8\u91CF\n 2. \u5176\u4F59\u63A5\u53E3\u81EA\u52A8\u7EE7\u627F `Authorization: Bearer {{token}}`\uFF0C\u76F4\u63A5\u8FD0\u884C\u5373\u53EF\n\n ## \u54CD\u5E94\u4FE1\u5C01\n\n \u6240\u6709\u63A5\u53E3\uFF08\u6587\u4EF6\u5BFC\u51FA\u9664\u5916\uFF09\u8FD4\u56DE\u7EDF\u4E00\u7ED3\u6784\uFF1A\n\n | \u5B57\u6BB5 | \u7C7B\u578B | \u8BF4\u660E |\n | --- | --- | --- |\n | code | number | \u7ED3\u679C\u7801\uFF0C0 \u4E3A\u6210\u529F |\n | success | boolean | \u662F\u5426\u6210\u529F\uFF0C\u5224\u6210\u529F\u53EA\u770B success === true |\n | message | string | \u5931\u8D25\u65F6\u4E3A\u9762\u5411\u7528\u6237\u7684\u4E2D\u6587\u63D0\u793A |\n | data | any | \u4E1A\u52A1\u6570\u636E\uFF0C\u53EF\u80FD\u4E3A null |\n\n \u4E1A\u52A1\u5931\u8D25 HTTP \u4ECD\u4E3A 200\uFF1B\u4EC5 401\uFF08\u672A\u767B\u5F55 40103\uFF09/ 403\uFF08\u65E0\u6743\u9650 40301\uFF09/ 404 / 500 \u4F8B\u5916\uFF0C\u54CD\u5E94\u4F53\u4ECD\u662F\u4FE1\u5C01\u7ED3\u6784\u3002\n\n ## \u9519\u8BEF\u7801\u5206\u6BB5\n\n | \u533A\u95F4 | \u542B\u4E49 |\n | --- | --- |\n | 400xx | \u53C2\u6570\u7C7B\u9519\u8BEF\uFF0840001 \u65F6 message \u4E3A\u300C\u5B57\u6BB5: \u63D0\u793A; \u5B57\u6BB52: \u63D0\u793A2\u300D\u683C\u5F0F\uFF09 |\n | 401xx | \u8BA4\u8BC1\u7C7B\u9519\u8BEF\uFF0840103 = \u672A\u767B\u5F55/\u8FC7\u671F\uFF0C\u9700\u91CD\u65B0\u767B\u5F55\uFF09 |\n | 403xx | \u6743\u9650\u7C7B\u9519\u8BEF |\n | 404xx / 405xx | \u8D44\u6E90\u4E0D\u5B58\u5728 / \u8BF7\u6C42\u65B9\u5F0F\u9519\u8BEF |\n | 500xx | \u7CFB\u7EDF/\u5916\u90E8\u8C03\u7528\u9519\u8BEF |\n | 6xxxx | \u4E1A\u52A1\u9519\u8BEF\uFF0C\u76F4\u63A5\u5C55\u793A message |\n\n ## \u4F20\u53C2\u7EA6\u5B9A\n\n - \u8BFB\u64CD\u4F5C\uFF1AGET\uFF0C\u53C2\u6570\u5168\u653E query\n - \u5199\u64CD\u4F5C\u4E0E\u5206\u9875\uFF1APOST\uFF0C`application/x-www-form-urlencoded` \u8868\u5355\uFF0C\u4E0D\u4F7F\u7528 JSON body\n - \u590D\u6742\u5B57\u6BB5\uFF08\u5BF9\u8C61/\u6570\u7EC4\uFF09\uFF1AJSON.stringify \u540E\u4F5C\u4E3A\u4E00\u4E2A\u666E\u901A\u8868\u5355\u5B57\u6BB5\u4F20\u9012\n - ID \u4E00\u5F8B\u6309\u5B57\u7B26\u4E32\u6536\u53D1\uFF08\u96EA\u82B1 ID \u8D85\u51FA JS \u5B89\u5168\u6574\u6570\u8303\u56F4\uFF09\n - \u65E5\u671F\u65F6\u95F4 `yyyy-MM-dd HH:mm:ss`\uFF0C\u65F6\u533A GMT+8\n\n ## \u5206\u9875\u89C4\u8303\n\n \u5165\u53C2\uFF08\u8868\u5355\u5B57\u6BB5\uFF09\uFF1Acurrent\uFF08\u4ECE 1 \u8D77\uFF09\u3001size\uFF08\u9ED8\u8BA4 10 \u4E0A\u9650 500\uFF09\u3001keyword\u3001orderBy\u3001asc\uFF08\u9ED8\u8BA4 false\uFF09\u3002\n \u51FA\u53C2 data\uFF1Acontent / total / size / current / pages / empty\u3002\n\n ## \u9875\u9762\u5F52\u5C5E\u89C4\u8303\uFF08\u672C collection \u6309\u9875\u9762\u7EC4\u7EC7\uFF09\n\n \u672C collection \u6309**\u524D\u7AEF\u9875\u9762/\u529F\u80FD\u83DC\u5355**\u5206\u6587\u4EF6\u5939\uFF08grouping: tag\uFF09\uFF0C\u4E00\u4E2A\u9875\u9762\u6587\u4EF6\u5939\u88C5\u9F50\u8BE5\u9875\u8054\u8C03\u8981\u8C03\u7684\u5168\u90E8\u63A5\u53E3\uFF08\u54EA\u6015\u5206\u6563\u5728\u4E0D\u540C\u540E\u7AEF\u5305\uFF09\u3002\u540E\u7AEF\u7528 springdoc/Swagger v3 \u7684**\u65B9\u6CD5\u7EA7** `@Operation(tags = {\"\u9875\u9762A\",\"\u9875\u9762B\"})` \u6253\u5206\u7EC4\uFF0C`tags` \u4E3A\u6570\u7EC4\u3001\u4E00\u4E2A\u63A5\u53E3\u53EF\u6302\u591A\u4E2A\u9875\u9762 tag\uFF1Btag \u540D\u8BF7\u7528\u524D\u7AEF\u9875\u9762/\u529F\u80FD\u83DC\u5355\u540D\u3002\u8001\u9879\u76EE\u7C7B\u7EA7 `@Tag(name = \"...\")` \u53EA\u80FD\u5355\u503C\uFF0C\u8DE8\u5305\u591A\u9875\u9762\u573A\u666F\u522B\u4F9D\u8D56\u5B83\u3002\u672A\u6253 tag \u7684\u63A5\u53E3\u56DE\u9000\u6309 URL \u5206\u5C42\u3002\n type: text/markdown\nbundled: true\nextensions:\n bruno:\n ignore:\n - node_modules\n - .git\n exportedAt: '2026-08-10T06:50:38.196Z'\n exportedUsing: Bruno/3.5.3\n";
|
|
new window.OpenCollection({
|
|
target: document.getElementById('opencollection-container'),
|
|
opencollection: collectionData,
|
|
theme: 'light'
|
|
});
|
|
</script>
|
|
</body>
|
|
</html>
|