Open
/
open-api
18
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

Merge branch 'hotfix/基础接口文档调整'

master 基础接口文档调整
张耀宗 12 months ago
parent
0b05480f77 dd6f7ea717
commit
0266c1dc7a
16 changed files with 37 additions and 51 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 6
      wms/供应商/修改供应商.md
  2. 8
      wms/供应商/删除供应商.md
  3. 2
      wms/供应商/新增供应商.md
  4. 8
      wms/供应商/获取供应商详情.md
  5. 4
      wms/员工/修改员工.md
  6. 4
      wms/员工/删除员工.md
  7. 4
      wms/员工/新增员工.md
  8. 4
      wms/员工/获取员工详情.md
  9. 4
      wms/客户/修改客户.md
  10. 6
      wms/客户/删除客户.md
  11. 2
      wms/客户/新增客户.md
  12. 8
      wms/客户/获取客户详情.md
  13. 6
      wms/部门/修改部门.md
  14. 10
      wms/部门/新增部门.md
  15. 6
      wms/部门/部门列表.md
  16. 4
      wms/部门/部门详情.md

6
wms/供应商/修改供应商.md
View File

@ -17,10 +17,9 @@ __请求参数__
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- | | :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区| | profile | String | 是 | 厂区|
| key | string | 是 | |
| code | string | 是 | 供应商编码 | | code | string | 是 | 供应商编码 |
| name | string | 是 | 供应商名称 | | name | string | 是 | 供应商名称 |
| status | string | 是 | 状态是否开启 | | status | string | 是 | 状态 1：开启 0：不开启 |
| country | string | 否 | 国家 | | country | string | 否 | 国家 |
| region | string | 否 | 省市 | | region | string | 否 | 省市 |
@ -28,8 +27,7 @@ __请求示例：__
``` ```
{ {
"data":{ "data":{
"profile": "测试", "profile": "测试",
"key":"d2d0916d46cc497e83e69ea9e307a92c",
"code":"wndSupplier", "code":"wndSupplier",
"name":"天天好集团aaa", "name":"天天好集团aaa",
"status": 0, "status": 0,

8
wms/供应商/删除供应商.md
View File

@ -17,16 +17,14 @@ __请求参数__
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- | | :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区| | profile | String | 是 | 厂区|
| key | string | 是 | 列表记录key | | code | string | 是 | 供应商编码 |
| code | string | 否 | 编码 |
__请求示例：__ __请求示例：__
``` ```
{ {
"data":{ "data":{
"profile": "测试", "profile": "测试",
"key": "", "code": "",
"code": "",
} }
} }
```` ````

2
wms/供应商/新增供应商.md
View File

@ -19,7 +19,7 @@ __请求参数__
| profile | String | 是 | 厂区| | profile | String | 是 | 厂区|
| code | string | 是 | 供应商编码 | | code | string | 是 | 供应商编码 |
| name | string | 是 | 供应商名称 | | name | string | 是 | 供应商名称 |
| status | string | 是 | 状态是否开启 | | status | string | 是 | 状态 1：开启 0：不开启 |
| country | string | 否 | 国家 | | country | string | 否 | 国家 |
| region | string | 否 | 省市 | | region | string | 否 | 省市 |

8
wms/供应商/获取供应商详情.md
View File

@ -17,16 +17,14 @@ __请求参数__
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- | | :-- | :-- | :-- | :-- |
| profile | string | 是 | 厂区| | profile | string | 是 | 厂区|
| key | string | 否 | | | code | string | 是 | 供应商编码 |
| code | string | 否 | 编码 |
__请求示例：__ __请求示例：__
``` ```
{ {
"data":{ "data":{
"profile": "测试", "profile": "测试",
"key" : "", "code": "GYS001",
"code": "GYS001",
} }
} }
```` ````

4
wms/员工/修改员工.md
View File

@ -18,19 +18,17 @@ __请求参数__
| :-- | :-- | :-- | :-- | | :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区| | profile | String | 是 | 厂区|
| userName | string | 是 | 用户登录名 | | userName | string | 是 | 用户登录名 |
| key | string | 是 | 记录主键 |
| password | string | 是 | 密码 | | password | string | 是 | 密码 |
| name | string | 是 | 员工姓名 | | name | string | 是 | 员工姓名 |
| departmentCode | string | 否 | 部门编码 | | departmentCode | string | 否 | 部门编码 |
| erpCode | string | 否 | ERP员工编号 | | erpCode | string | 否 | ERP员工编号 |
| status | int | 是 | 状态 | | status | int | 是 | 状态 1：启用 0：不启用|
__请求示例：__ __请求示例：__
``` ```
{ {
"data":{ "data":{
"profile":"测试", "profile":"测试",
"key": "5fd5de9e9d48417881aa457be6500bcb",
"userName":"zhangyz", "userName":"zhangyz",
"password":"123456", "password":"123456",
"name":"非凡", "name":"非凡",

4
wms/员工/删除员工.md
View File

@ -17,14 +17,14 @@ __请求参数__
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- | | :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区| | profile | String | 是 | 厂区|
| keyWord | string | 是 | 记录主键 | | userName | string | 是 | 登录用户名 |
__请求示例：__ __请求示例：__
``` ```
{ {
"data":{ "data":{
"profile": "测试", "profile": "测试",
"keyWord":"5fd5de9e9d48417881aa457be6500bcb", "userName":"",
} }
} }
```` ````

4
wms/员工/新增员工.md
View File

@ -22,13 +22,13 @@ __请求参数__
| name | string | 是 | 员工姓名 | | name | string | 是 | 员工姓名 |
| departmentCode | string | 否 | 部门编码 | | departmentCode | string | 否 | 部门编码 |
| erpCode | string | 否 | ERP员工编号 | | erpCode | string | 否 | ERP员工编号 |
| status | int | 是 | 状态 | | status | int | 是 | 状态 1：启用 0：不启用 |
__请求示例：__ __请求示例：__
``` ```
{ {
"data":{ "data":{
"profile":"测试", "profile":"测试",
"userName":"zhangyz", "userName":"zhangyz",
"password":"12345", "password":"12345",
"name":"非凡", "name":"非凡",

4
wms/员工/获取员工详情.md
View File

@ -17,14 +17,14 @@ __请求参数__
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- | | :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区| | profile | String | 是 | 厂区|
| keyWord | string | 是 | 记录主键 | | userName | string | 是 | 登录用户名 |
__请求示例：__ __请求示例：__
``` ```
{ {
"data":{ "data":{
"profile": "测试", "profile": "测试",
"keyWord":"5fd5de9e9d48417881aa457be6500bcb", "userName":"",
} }
} }
```` ````

4
wms/客户/修改客户.md
View File

@ -19,9 +19,8 @@ __请求参数__
| profile | String | 是 | 厂区| | profile | String | 是 | 厂区|
| code | String | 是 | 客户编码| | code | String | 是 | 客户编码|
| name | String | 是 | 客户名称| | name | String | 是 | 客户名称|
| key | String | 是| |
| country | String | 否 | 国家| | country | String | 否 | 国家|
| region | String | 是 | 省市| | region | String | 否 | 省市|
| status | int | 是 | 状态 1：启用 0：不启用| | status | int | 是 | 状态 1：启用 0：不启用|
__请求示例：__ __请求示例：__
@ -34,7 +33,6 @@ __请求示例：__
"country":"china", "country":"china",
"region":"shanghai", "region":"shanghai",
"status":0, "status":0,
"key":"45960622d4a54c69b2e26a840056ff48"
} }
} }
```` ````

6
wms/客户/删除客户.md
View File

@ -17,16 +17,14 @@ __请求参数__
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- | | :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区| | profile | String | 是 | 厂区|
| key | string | 是 | | | code | string | 是 | 客户编码 |
| code | string | 否(优先按key删除) | |
__请求示例：__ __请求示例：__
``` ```
{ {
"data":{ "data":{
"profile": "测试", "profile": "测试",
"key": "2fadc517f26446069930ecb8a3f59356", "code" : "code001"
"code" : "code001"
} }
} }
```` ````

2
wms/客户/新增客户.md
View File

@ -20,7 +20,7 @@ __请求参数__
| code | String | 是 | 客户编码| | code | String | 是 | 客户编码|
| name | String | 是 | 客户名称| | name | String | 是 | 客户名称|
| country | String | 否 | 国家| | country | String | 否 | 国家|
| region | String | 是 | 省市| | region | String | 否 | 省市|
| status | int | 是 | 状态 1：启用 0：不启用| | status | int | 是 | 状态 1：启用 0：不启用|
__请求示例：__ __请求示例：__

8
wms/客户/获取客户详情.md
View File

@ -17,16 +17,14 @@ __请求参数__
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- | | :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区| | profile | String | 是 | 厂区|
| code | string | | | | code | string | 是 | 客户编码 |
| key | string | | |
__请求示例：__ __请求示例：__
``` ```
{ {
"data":{ "data":{
"profile":"测试", "profile":"测试",
"code":"wnC1", "code":"wnC1",
"key": "",
} }
} }
```` ````

6
wms/部门/修改部门.md
View File

@ -17,18 +17,16 @@ __请求参数__
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- | | :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区| | profile | String | 是 | 厂区|
| key | string | 是 | |
| code | string | 是 | 部门编码 | | code | string | 是 | 部门编码 |
| name | string | 是 | 部门名称 | | name | string | 是 | 部门名称 |
| status | int | 是 | 状态 | | status | int | 是 | 状态 1：启用 0：不启用 |
| parentCode | string | 是 | 上级部门 | | parentCode | string | 否 | 上级部门 |
__请求示例：__ __请求示例：__
``` ```
{ {
"data":{ "data":{
"profile":"测试", "profile":"测试",
"key":"c1f3202cc1ac4a9baa0ea48813e44635",
"code": "woniuDep", "code": "woniuDep",
"name":"测试部门", "name":"测试部门",
"status": 1, "status": 1,

10
wms/部门/新增部门.md
View File

@ -19,8 +19,8 @@ __请求参数__
| profile | String | 是 | 厂区| | profile | String | 是 | 厂区|
| code | string | 是 | 部门编码 | | code | string | 是 | 部门编码 |
| name | string | 是 | 部门名称 | | name | string | 是 | 部门名称 |
| status | int | 是 | 状态 | | status | int | 是 | 状态 1：启用 0：不启用 |
| parentCode | string | 是 | 上级部门 | | parentCode | string | 否 | 上级部门 |
__请求示例：__ __请求示例：__
@ -29,9 +29,9 @@ __请求示例：__
"data":{ "data":{
"profile": "测试", "profile": "测试",
"code": "dep1", "code": "dep1",
"name":"部门1", "name":"部门1",
"status": 0, "status": 0,
"parentCode":"", "parentCode":"",
} }
} }
```` ````

6
wms/部门/部门列表.md
View File

@ -52,14 +52,16 @@ __data:__
"code": "100008", "code": "100008",
"name": "财务管理部", "name": "财务管理部",
"createTime": "2022-09-30 08:54:01", "createTime": "2022-09-30 08:54:01",
"status": 0 "status": 0，
"parentCode":"",
}, },
{ {
"key": "e7ed256eb16343b29f1d2c542fbea7ca", "key": "e7ed256eb16343b29f1d2c542fbea7ca",
"code": "100009", "code": "100009",
"name": "电站业务部", "name": "电站业务部",
"createTime": "2022-09-30 08:54:02", "createTime": "2022-09-30 08:54:02",
"status": 0 "status": 0，
"parentCode":"",
} }
] ]
} }

4
wms/部门/部门详情.md
View File

@ -17,14 +17,14 @@ __请求参数__
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| :-- | :-- | :-- | :-- | | :-- | :-- | :-- | :-- |
| profile | String | 是 | 厂区| | profile | String | 是 | 厂区|
| keyWord | string | 是 | 部门编码 | | code | string | 是 | 部门编码 |
__请求示例：__ __请求示例：__
``` ```
{ {
"data":{ "data":{
"profile": "测试", "profile": "测试",
"keyWord" :"woniuDep", "code" :"woniuDep",
} }
} }
```` ````

Write Preview
Loading…
Cancel
Save