Boonlive_RD_Web/Web_BAI_Manage_ApiServer
9
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: 更新 API 响应结构，统一使用 statusCode 和 errMsg 替代 code 和 msg；新增用户类型和公司 ID 字段；优化数据库索引；添加公司所有者同步测试脚本

Browse Source
This commit is contained in:
徐
2026-03-29 19:57:04 +08:00
parent e9fe1165e3
commit 50c09d855b
50 changed files with 851 additions and 601 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
pocket-base/bai-api-main.pb.js
View File

@@ -1,5 +1,7 @@
/// <reference path="../pb_data/types.d.ts" />
const { fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
routerUse(function (e) {
try {
return e.next()
@@ -9,11 +11,7 @@ routerUse(function (e) {
|| (err && typeof err.status === 'number' && err.status)
|| 500
return e.json(status, {
code: status,
msg: (err && err.message) || '服务器内部错误',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '服务器内部错误', (err && err.data) || {}, status)
}
})
@@ -47,3 +45,5 @@ require(`${__hooks}/bai_api_pb_hooks/bai_api_routes/sdk-permission/collection-sa
require(`${__hooks}/bai_api_pb_hooks/bai_api_routes/sdk-permission/manageplatform-sync.js`)
require(`${__hooks}/bai_api_pb_hooks/bai_api_routes/wechat/login.js`)
require(`${__hooks}/bai_api_pb_hooks/bai_api_routes/wechat/profile.js`)

15
pocket-base/bai_api_pb_hooks/bai_api_routes/attachment/delete.js
View File

@@ -2,7 +2,7 @@ routerAdd('POST', '/api/attachment/delete', function (e) {
const guards = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js`)
const documentService = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/services/documentService.js`)
const logger = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/logger.js`)
const { success } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
const { success, fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
try {
guards.requireJson(e)
@@ -17,13 +17,14 @@ routerAdd('POST', '/api/attachment/delete', function (e) {
const status = (err && err.statusCode) || (err && err.status) || 400
logger.error('删除附件失败', {
status: status,
message: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return e.json(status, {
code: status,
msg: (err && err.message) || '删除附件失败',
errMsg: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '操作失败', (err && err.data) || {}, status)
}
})

15
pocket-base/bai_api_pb_hooks/bai_api_routes/attachment/detail.js
View File

@@ -2,7 +2,7 @@ routerAdd('POST', '/api/attachment/detail', function (e) {
const guards = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js`)
const documentService = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/services/documentService.js`)
const logger = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/logger.js`)
const { success } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
const { success, fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
try {
guards.requireJson(e)
@@ -16,13 +16,14 @@ routerAdd('POST', '/api/attachment/detail', function (e) {
const status = (err && err.statusCode) || (err && err.status) || 400
logger.error('查询附件详情失败', {
status: status,
message: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return e.json(status, {
code: status,
msg: (err && err.message) || '查询附件详情失败',
errMsg: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '操作失败', (err && err.data) || {}, status)
}
})

15
pocket-base/bai_api_pb_hooks/bai_api_routes/attachment/list.js
View File

@@ -2,7 +2,7 @@ routerAdd('POST', '/api/attachment/list', function (e) {
const guards = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js`)
const documentService = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/services/documentService.js`)
const logger = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/logger.js`)
const { success } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
const { success, fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
try {
guards.requireJson(e)
@@ -18,13 +18,14 @@ routerAdd('POST', '/api/attachment/list', function (e) {
const status = (err && err.statusCode) || (err && err.status) || 400
logger.error('查询附件列表失败', {
status: status,
message: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return e.json(status, {
code: status,
msg: (err && err.message) || '查询附件列表失败',
errMsg: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '操作失败', (err && err.data) || {}, status)
}
})

15
pocket-base/bai_api_pb_hooks/bai_api_routes/attachment/upload.js
View File

@@ -2,7 +2,7 @@ routerAdd('POST', '/api/attachment/upload', function (e) {
const guards = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js`)
const documentService = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/services/documentService.js`)
const logger = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/logger.js`)
const { success } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
const { success, fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
try {
const authState = guards.requireManagePlatformUser(e)
@@ -16,13 +16,14 @@ routerAdd('POST', '/api/attachment/upload', function (e) {
const status = (err && err.statusCode) || (err && err.status) || 400
logger.error('上传附件失败', {
status: status,
message: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return e.json(status, {
code: status,
msg: (err && err.message) || '上传附件失败',
errMsg: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '操作失败', (err && err.data) || {}, status)
}
}, $apis.bodyLimit(536870912))

22
pocket-base/bai_api_pb_hooks/bai_api_routes/company/records-create.js
View File

@@ -1,17 +1,7 @@
onRecordAfterCreateSuccess((e) => {
try {
const authRecord = e && e.auth ? e.auth : null
if (!authRecord || authRecord.collection().name !== 'tbl_auth_users') {
return
}
if (authRecord.getString('users_type') === '服务商') {
return
}
authRecord.set('users_type', '服务商')
$app.save(authRecord)
} catch (_error) {
// Keep company create flow unchanged even if user type sync fails.
}
onRecordCreateRequest((e) => {
return e.next()
}, 'tbl_company')
onRecordUpdateRequest((e) => {
return e.next()
}, 'tbl_company')

16
pocket-base/bai_api_pb_hooks/bai_api_routes/dictionary/create.js
View File

@@ -2,7 +2,7 @@ routerAdd('POST', '/api/dictionary/create', function (e) {
const guards = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js`)
const dictionaryService = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/services/dictionaryService.js`)
const logger = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/logger.js`)
const { success } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
const { success, fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
try {
guards.requireJson(e)
@@ -17,13 +17,13 @@ routerAdd('POST', '/api/dictionary/create', function (e) {
const status = (err && err.statusCode) || (err && err.status) || 400
logger.error('新增字典失败', {
status: status,
message: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return e.json(status, {
code: status,
msg: (err && err.message) || '新增字典失败',
errMsg: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '操作失败', (err && err.data) || {}, status)
}
})
})

16
pocket-base/bai_api_pb_hooks/bai_api_routes/dictionary/delete.js
View File

@@ -2,7 +2,7 @@ routerAdd('POST', '/api/dictionary/delete', function (e) {
const guards = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js`)
const dictionaryService = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/services/dictionaryService.js`)
const logger = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/logger.js`)
const { success } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
const { success, fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
try {
guards.requireJson(e)
@@ -17,13 +17,13 @@ routerAdd('POST', '/api/dictionary/delete', function (e) {
const status = (err && err.statusCode) || (err && err.status) || 400
logger.error('删除字典失败', {
status: status,
message: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return e.json(status, {
code: status,
msg: (err && err.message) || '删除字典失败',
errMsg: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '操作失败', (err && err.data) || {}, status)
}
})
})

15
pocket-base/bai_api_pb_hooks/bai_api_routes/dictionary/detail.js
View File

@@ -2,7 +2,7 @@ routerAdd('POST', '/api/dictionary/detail', function (e) {
const guards = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js`)
const dictionaryService = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/services/dictionaryService.js`)
const logger = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/logger.js`)
const { success } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
const { success, fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
try {
guards.requireJson(e)
@@ -15,13 +15,14 @@ routerAdd('POST', '/api/dictionary/detail', function (e) {
const status = (err && err.statusCode) || (err && err.status) || 400
logger.error('查询字典详情失败', {
status: status,
message: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return e.json(status, {
code: status,
msg: (err && err.message) || '查询字典详情失败',
errMsg: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '操作失败', (err && err.data) || {}, status)
}
})

15
pocket-base/bai_api_pb_hooks/bai_api_routes/dictionary/list.js
View File

@@ -2,7 +2,7 @@ routerAdd('POST', '/api/dictionary/list', function (e) {
const guards = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js`)
const dictionaryService = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/services/dictionaryService.js`)
const logger = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/logger.js`)
const { success } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
const { success, fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
try {
guards.requireJson(e)
@@ -17,13 +17,14 @@ routerAdd('POST', '/api/dictionary/list', function (e) {
const status = (err && err.statusCode) || (err && err.status) || 400
logger.error('查询字典列表失败', {
status: status,
message: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return e.json(status, {
code: status,
msg: (err && err.message) || '查询字典列表失败',
errMsg: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '操作失败', (err && err.data) || {}, status)
}
})

16
pocket-base/bai_api_pb_hooks/bai_api_routes/dictionary/update.js
View File

@@ -2,7 +2,7 @@ routerAdd('POST', '/api/dictionary/update', function (e) {
const guards = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js`)
const dictionaryService = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/services/dictionaryService.js`)
const logger = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/logger.js`)
const { success } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
const { success, fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
try {
guards.requireJson(e)
@@ -17,13 +17,13 @@ routerAdd('POST', '/api/dictionary/update', function (e) {
const status = (err && err.statusCode) || (err && err.status) || 400
logger.error('修改字典失败', {
status: status,
message: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return e.json(status, {
code: status,
msg: (err && err.message) || '修改字典失败',
errMsg: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '操作失败', (err && err.data) || {}, status)
}
})
})

15
pocket-base/bai_api_pb_hooks/bai_api_routes/document-history/list.js
View File

@@ -2,7 +2,7 @@ routerAdd('POST', '/api/document-history/list', function (e) {
const guards = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js`)
const documentService = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/services/documentService.js`)
const logger = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/logger.js`)
const { success } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
const { success, fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
try {
guards.requireJson(e)
@@ -18,13 +18,14 @@ routerAdd('POST', '/api/document-history/list', function (e) {
const status = (err && err.statusCode) || (err && err.status) || 400
logger.error('查询文档操作历史失败', {
status: status,
message: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return e.json(status, {
code: status,
msg: (err && err.message) || '查询文档操作历史失败',
errMsg: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '操作失败', (err && err.data) || {}, status)
}
})

15
pocket-base/bai_api_pb_hooks/bai_api_routes/document/create.js
View File

@@ -2,7 +2,7 @@ routerAdd('POST', '/api/document/create', function (e) {
const guards = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js`)
const documentService = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/services/documentService.js`)
const logger = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/logger.js`)
const { success } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
const { success, fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
try {
guards.requireJson(e)
@@ -17,13 +17,14 @@ routerAdd('POST', '/api/document/create', function (e) {
const status = (err && err.statusCode) || (err && err.status) || 400
logger.error('新增文档失败', {
status: status,
message: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return e.json(status, {
code: status,
msg: (err && err.message) || '新增文档失败',
errMsg: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '操作失败', (err && err.data) || {}, status)
}
})

15
pocket-base/bai_api_pb_hooks/bai_api_routes/document/delete.js
View File

@@ -2,7 +2,7 @@ routerAdd('POST', '/api/document/delete', function (e) {
const guards = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js`)
const documentService = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/services/documentService.js`)
const logger = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/logger.js`)
const { success } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
const { success, fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
try {
guards.requireJson(e)
@@ -17,13 +17,14 @@ routerAdd('POST', '/api/document/delete', function (e) {
const status = (err && err.statusCode) || (err && err.status) || 400
logger.error('删除文档失败', {
status: status,
message: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return e.json(status, {
code: status,
msg: (err && err.message) || '删除文档失败',
errMsg: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '操作失败', (err && err.data) || {}, status)
}
})

15
pocket-base/bai_api_pb_hooks/bai_api_routes/document/detail.js
View File

@@ -2,7 +2,7 @@ routerAdd('POST', '/api/document/detail', function (e) {
const guards = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js`)
const documentService = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/services/documentService.js`)
const logger = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/logger.js`)
const { success } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
const { success, fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
try {
guards.requireJson(e)
@@ -16,13 +16,14 @@ routerAdd('POST', '/api/document/detail', function (e) {
const status = (err && err.statusCode) || (err && err.status) || 400
logger.error('查询文档详情失败', {
status: status,
message: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return e.json(status, {
code: status,
msg: (err && err.message) || '查询文档详情失败',
errMsg: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '操作失败', (err && err.data) || {}, status)
}
})

15
pocket-base/bai_api_pb_hooks/bai_api_routes/document/list.js
View File

@@ -2,7 +2,7 @@ routerAdd('POST', '/api/document/list', function (e) {
const guards = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js`)
const documentService = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/services/documentService.js`)
const logger = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/logger.js`)
const { success } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
const { success, fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
try {
guards.requireJson(e)
@@ -18,13 +18,14 @@ routerAdd('POST', '/api/document/list', function (e) {
const status = (err && err.statusCode) || (err && err.status) || 400
logger.error('查询文档列表失败', {
status: status,
message: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return e.json(status, {
code: status,
msg: (err && err.message) || '查询文档列表失败',
errMsg: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '操作失败', (err && err.data) || {}, status)
}
})

15
pocket-base/bai_api_pb_hooks/bai_api_routes/document/update.js
View File

@@ -2,7 +2,7 @@ routerAdd('POST', '/api/document/update', function (e) {
const guards = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js`)
const documentService = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/services/documentService.js`)
const logger = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/logger.js`)
const { success } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
const { success, fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
try {
guards.requireJson(e)
@@ -17,13 +17,14 @@ routerAdd('POST', '/api/document/update', function (e) {
const status = (err && err.statusCode) || (err && err.status) || 400
logger.error('修改文档失败', {
status: status,
message: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return e.json(status, {
code: status,
msg: (err && err.message) || '修改文档失败',
errMsg: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '操作失败', (err && err.data) || {}, status)
}
})

16
pocket-base/bai_api_pb_hooks/bai_api_routes/platform/login.js
View File

@@ -2,7 +2,7 @@ routerAdd('POST', '/api/platform/login', function (e) {
const guards = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js`)
const userService = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/services/userService.js`)
const logger = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/logger.js`)
const { successWithToken } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
const { successWithToken, fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
try {
guards.requireJson(e)
@@ -20,14 +20,14 @@ routerAdd('POST', '/api/platform/login', function (e) {
logger.error('平台登录失败', {
status: status,
message: (err && err.message) || '未知错误',
errMsg: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return e.json(status, {
code: status,
msg: (err && err.message) || '平台登录失败',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '操作失败', (err && err.data) || {}, status)
}
})
})

16
pocket-base/bai_api_pb_hooks/bai_api_routes/platform/register.js
View File

@@ -2,7 +2,7 @@ routerAdd('POST', '/api/platform/register', function (e) {
const guards = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js`)
const userService = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/services/userService.js`)
const logger = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/logger.js`)
const { successWithToken } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
const { successWithToken, fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
try {
guards.requireJson(e)
@@ -21,14 +21,14 @@ routerAdd('POST', '/api/platform/register', function (e) {
logger.error('平台注册失败', {
status: status,
message: (err && err.message) || '未知错误',
errMsg: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return e.json(status, {
code: status,
msg: (err && err.message) || '平台注册失败',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '操作失败', (err && err.data) || {}, status)
}
})
})

2
pocket-base/bai_api_pb_hooks/bai_api_routes/sdk-permission/collection-save.js
View File

@@ -12,3 +12,5 @@ routerAdd('POST', '/api/sdk-permission/collection-save', function (e) {
return success(e, '保存集合权限成功', data)
})

2
pocket-base/bai_api_pb_hooks/bai_api_routes/sdk-permission/context.js
View File

@@ -11,3 +11,5 @@ routerAdd('POST', '/api/sdk-permission/context', function (e) {
return success(e, '查询权限管理上下文成功', data)
})

2
pocket-base/bai_api_pb_hooks/bai_api_routes/sdk-permission/manageplatform-sync.js
View File

@@ -11,3 +11,5 @@ routerAdd('POST', '/api/sdk-permission/manageplatform-sync', function (e) {
return success(e, '已同步 ManagePlatform 业务全权限', data)
})

2
pocket-base/bai_api_pb_hooks/bai_api_routes/sdk-permission/role-delete.js
View File

@@ -12,3 +12,5 @@ routerAdd('POST', '/api/sdk-permission/role-delete', function (e) {
return success(e, '删除角色成功', data)
})

2
pocket-base/bai_api_pb_hooks/bai_api_routes/sdk-permission/role-save.js
View File

@@ -12,3 +12,5 @@ routerAdd('POST', '/api/sdk-permission/role-save', function (e) {
return success(e, '保存角色成功', data)
})

2
pocket-base/bai_api_pb_hooks/bai_api_routes/sdk-permission/user-role-update.js
View File

@@ -12,3 +12,5 @@ routerAdd('POST', '/api/sdk-permission/user-role-update', function (e) {
return success(e, '更新用户角色成功', data)
})

2
pocket-base/bai_api_pb_hooks/bai_api_routes/system/health.js
View File

@@ -8,3 +8,5 @@ routerAdd('POST', '/api/system/health', function (e) {
timestamp: new Date().toISOString(),
})
})

2
pocket-base/bai_api_pb_hooks/bai_api_routes/system/hello.js
View File

@@ -9,3 +9,5 @@ routerAdd('POST', '/api/system/test-helloworld', function (e) {
build_time: env.buildTime,
})
})

22
pocket-base/bai_api_pb_hooks/bai_api_routes/system/refresh-token.js
View File

@@ -2,7 +2,7 @@ routerAdd('POST', '/api/system/refresh-token', function (e) {
const guards = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js`)
const userService = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/services/userService.js`)
const logger = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/logger.js`)
const { successWithToken } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
const { successWithToken, fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
try {
guards.requireJson(e)
@@ -19,11 +19,7 @@ routerAdd('POST', '/api/system/refresh-token', function (e) {
}
if (!payload.users_wx_code) {
return e.json(401, {
code: 401,
msg: 'token已过期，请上传users_wx_code',
data: {},
})
return fail(e, 'token已过期，请上传users_wx_code', {}, 401)
}
const authData = userService.authenticateWechatUser(payload)
@@ -38,14 +34,14 @@ routerAdd('POST', '/api/system/refresh-token', function (e) {
logger.error('系统刷新令牌失败', {
status: status,
message: (err && err.message) || '未知错误',
errMsg: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return e.json(status, {
code: status,
msg: (err && err.message) || '刷新失败',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '操作失败', (err && err.data) || {}, status)
}
})
})

3
pocket-base/bai_api_pb_hooks/bai_api_routes/system/users-count.js
View File

@@ -27,4 +27,5 @@ routerAdd('POST', '/api/system/users-count', function (e) {
return success(e, '查询成功', {
total_users: total,
})
})
})

15
pocket-base/bai_api_pb_hooks/bai_api_routes/wechat/login.js
View File

@@ -2,7 +2,7 @@ routerAdd('POST', '/api/wechat/login', function (e) {
const guards = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js`)
const userService = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/services/userService.js`)
const logger = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/logger.js`)
const { successWithToken } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
const { successWithToken, fail } = require(`${__hooks}/bai_api_pb_hooks/bai_api_shared/utils/response.js`)
try {
guards.requireJson(e)
@@ -21,14 +21,15 @@ routerAdd('POST', '/api/wechat/login', function (e) {
logger.error('微信登录失败', {
status: status,
message: (err && err.message) || '未知错误',
errMsg: (err && err.message) || '未知错误',
data: (err && err.data) || {},
})
return e.json(status, {
code: status,
msg: (err && err.message) || '微信登录失败',
data: (err && err.data) || {},
})
return fail(e, (err && err.message) || '操作失败', (err && err.data) || {}, status)
}
})

2
pocket-base/bai_api_pb_hooks/bai_api_routes/wechat/profile.js
View File

@@ -12,3 +12,5 @@ routerAdd('POST', '/api/wechat/profile', function (e) {
return success(e, '信息更新成功', data)
})

9
pocket-base/bai_api_pb_hooks/bai_api_shared/middlewares/requestGuards.js
View File

@@ -29,6 +29,8 @@ function validateProfileBody(e) {
users_name: Object.prototype.hasOwnProperty.call(payload, 'users_name') ? String(payload.users_name || '').trim() : undefined,
users_phone_code: Object.prototype.hasOwnProperty.call(payload, 'users_phone_code') ? String(payload.users_phone_code || '').trim() : undefined,
users_phone: Object.prototype.hasOwnProperty.call(payload, 'users_phone') ? String(payload.users_phone || '').trim() : undefined,
users_type: Object.prototype.hasOwnProperty.call(payload, 'users_type') ? String(payload.users_type || '').trim() : undefined,
company_id: Object.prototype.hasOwnProperty.call(payload, 'company_id') ? String(payload.company_id || '').trim() : undefined,
users_tag: Object.prototype.hasOwnProperty.call(payload, 'users_tag') ? String(payload.users_tag || '').trim() : undefined,
users_picture: Object.prototype.hasOwnProperty.call(payload, 'users_picture') ? String(payload.users_picture || '').trim() : undefined,
users_id_pic_a: Object.prototype.hasOwnProperty.call(payload, 'users_id_pic_a') ? payload.users_id_pic_a : undefined,
@@ -74,14 +76,15 @@ function validatePlatformRegisterBody(e) {
function validatePlatformLoginBody(e) {
const payload = parseBody(e)
const loginAccount = payload.login_account || payload.users_phone || payload.email || ''
const loginAccount = String(payload.login_account || payload.users_phone || payload.email || '').trim()
const password = String(payload.password || '')
if (!loginAccount) throw createAppError(400, 'login_account 为必填项，支持邮箱或手机号')
if (!payload.password) throw createAppError(400, 'password 为必填项')
if (!password) throw createAppError(400, 'password 为必填项')
return {
login_account: loginAccount,
password: payload.password,
password: password,
}
}

82
pocket-base/bai_api_pb_hooks/bai_api_shared/services/userService.js
View File

@@ -112,6 +112,32 @@ function parseHttpJsonResponse(response) {
})
}
function decodeHttpBodyText(body) {
if (typeof body === 'string') {
return body
}
if (Array.isArray(body)) {
return body.map(function (code) {
return String.fromCharCode(Number(code) || 0)
}).join('')
}
if (body && typeof body.length === 'number' && typeof body !== 'function') {
try {
let text = ''
for (let i = 0; i < body.length; i += 1) {
text += String.fromCharCode(Number(body[i]) || 0)
}
return text
} catch (_err) {
return String(body || '')
}
}
return String(body || '')
}
function getCompanyByCompanyId(companyId) {
if (!companyId) return null
const records = $app.findRecordsByFilter('tbl_company', 'company_id = {:companyId}', '', 1, 0, {
@@ -120,6 +146,14 @@ function getCompanyByCompanyId(companyId) {
return records.length ? records[0] : null
}
function getCompanyByOwnerOpenid(openid) {
if (!openid) return null
const records = $app.findRecordsByFilter('tbl_company', 'company_owner_openid = {:openid}', '', 1, 0, {
openid: openid,
})
return records.length ? records[0] : null
}
function exportCompany(companyRecord) {
if (!companyRecord) return null
return {
@@ -211,9 +245,17 @@ function applyUserAttachmentFields(record, payload) {
}
function enrichUser(userRecord) {
const companyId = userRecord.getString('company_id')
const companyRecord = getCompanyByCompanyId(companyId)
const openid = userRecord.getString('openid')
let companyId = userRecord.getString('company_id')
let companyRecord = getCompanyByCompanyId(companyId)
if (!companyRecord && openid) {
companyRecord = getCompanyByOwnerOpenid(openid)
if (companyRecord) {
companyId = companyRecord.getString('company_id')
}
}
const userPicture = resolveUserAttachment(userRecord.getString('users_picture'))
const userIdPicA = resolveUserAttachment(userRecord.getString('users_id_pic_a'))
const userIdPicB = resolveUserAttachment(userRecord.getString('users_id_pic_b'))
@@ -259,8 +301,8 @@ function enrichUser(userRecord) {
function buildAuthMeta(user) {
return {
code: 200,
msg: '操作成功',
statusCode: 200,
errMsg: '操作成功',
data: {
status: user.status,
is_info_complete: user.is_info_complete,
@@ -472,9 +514,25 @@ function authenticatePlatformUser(payload) {
})
if (!authResponse || authResponse.statusCode < 200 || authResponse.statusCode >= 300) {
throw createAppError(400, '平台登录失败', {
const responseBodyText = authResponse ? decodeHttpBodyText(authResponse.body) : ''
let responseBody = {}
try {
responseBody = responseBodyText ? JSON.parse(responseBodyText) : {}
} catch (_err) {
responseBody = {}
}
const originalMessage = responseBody.message || ''
const normalizedMessage = originalMessage === 'Something went wrong while processing your request.'
? '账号或密码错误'
: (originalMessage || '平台登录失败')
throw createAppError(400, normalizedMessage, {
statusCode: authResponse ? authResponse.statusCode : 0,
body: authResponse ? String(authResponse.body || '') : '',
originalMessage: originalMessage,
originalData: responseBody.data || {},
body: responseBodyText,
})
}
@@ -538,12 +596,19 @@ function updateWechatUserProfile(usersWxOpenid, payload) {
if (usersPhone) {
currentUser.set('users_phone', usersPhone)
}
if (typeof payload.users_type !== 'undefined' && payload.users_type) {
currentUser.set('users_type', payload.users_type)
}
if (typeof payload.company_id !== 'undefined' && payload.company_id) {
currentUser.set('company_id', payload.company_id)
}
if (typeof payload.users_tag !== 'undefined' && payload.users_tag) {
currentUser.set('users_tag', payload.users_tag)
}
applyUserAttachmentFields(currentUser, payload)
const shouldPromote = ((currentUser.getString('users_type') || GUEST_USER_TYPE) === GUEST_USER_TYPE)
&& typeof payload.users_type === 'undefined'
&& isInfoComplete(currentUser)
if (shouldPromote) {
currentUser.set('users_type', REGISTERED_USER_TYPE)
@@ -582,8 +647,8 @@ function refreshAuthToken(openid) {
authRecord: userRecord,
authMethod: '',
meta: {
code: 200,
msg: '刷新成功',
statusCode: 200,
errMsg: '刷新成功',
data: {},
},
}
@@ -623,3 +688,4 @@ module.exports = {
issueAuthToken,
registerPlatformUser,
}

61
pocket-base/bai_api_pb_hooks/bai_api_shared/utils/response.js
View File

@@ -1,27 +1,64 @@
function applyHttpMeta(e, code, msg) {
const statusCode = code || 200
const errMsg = msg || '操作成功'
try {
const res = e && typeof e.response === 'function' ? e.response() : null
const headers = res && typeof res.header === 'function' ? res.header() : null
if (headers && typeof headers.set === 'function') {
headers.set('X-Status-Code', String(statusCode))
headers.set('X-Err-Msg', encodeURIComponent(errMsg))
headers.set('Access-Control-Expose-Headers', 'X-Status-Code, X-Err-Msg')
}
} catch (_err) {
// Header injection failures should not break API responses.
}
return {
statusCode,
errMsg,
}
}
function normalizePayloadData(data) {
if (typeof data === 'undefined' || data === null) {
return {}
}
if (data && typeof data === 'object' && !Array.isArray(data)) {
return data
}
return {
data: data,
}
}
function success(e, msg, data, code) {
return e.json(code || 200, {
code: code || 200,
msg: msg || '操作成功',
data: data || {},
})
const meta = applyHttpMeta(e, code || 200, msg || '操作成功')
return e.json(meta.statusCode, normalizePayloadData(data))
}
function successWithToken(e, msg, data, token, code) {
const statusCode = code || 200
const payload = {
code: statusCode,
msg: msg || '操作成功',
data: data || {},
}
const meta = applyHttpMeta(e, code || 200, msg || '操作成功')
const payload = normalizePayloadData(data)
if (token) {
payload.token = token
}
return e.json(statusCode, payload)
return e.json(meta.statusCode, payload)
}
function fail(e, msg, data, code) {
const meta = applyHttpMeta(e, code || 400, msg || '操作失败')
return e.json(meta.statusCode, normalizePayloadData(data))
}
module.exports = {
success,
successWithToken,
fail,
}

43
pocket-base/bai_web_pb_hooks/pages/dictionary-manage.js
View File

@@ -257,6 +257,33 @@ routerAdd('GET', '/manage/dictionary-manage', function (e) {
return localStorage.getItem(tokenKey) || ''
}
function decodeErrMsg(value) {
if (!value) {
return ''
}
try {
return decodeURIComponent(value)
} catch (_err) {
return String(value)
}
}
function unwrapApiResponse(data, res) {
const safe = data && typeof data === 'object' ? data : {}
const headerCode = Number(res && res.headers ? (res.headers.get('X-Status-Code') || 0) : 0)
const headerErrMsg = decodeErrMsg(res && res.headers ? res.headers.get('X-Err-Msg') : '')
const code = Number(safe.statusCode || safe.code || headerCode || 0)
const errMsg = safe.errMsg || safe.msg || headerErrMsg || ''
const hasLegacyEnvelope = Object.prototype.hasOwnProperty.call(safe, 'data')
&& (Object.prototype.hasOwnProperty.call(safe, 'code')
|| Object.prototype.hasOwnProperty.call(safe, 'statusCode')
|| Object.prototype.hasOwnProperty.call(safe, 'msg')
|| Object.prototype.hasOwnProperty.call(safe, 'errMsg'))
const payload = hasLegacyEnvelope ? (safe.data || {}) : safe
return { code: code, errMsg: errMsg, payload: payload }
}
async function request(url, payload) {
const token = getToken()
if (!token) {
@@ -275,18 +302,19 @@ routerAdd('GET', '/manage/dictionary-manage', function (e) {
})
const data = await res.json()
if (!res.ok || data.code >= 400) {
if (res.status === 401 || res.status === 403 || data.code === 401 || data.code === 403) {
const unwrapped = unwrapApiResponse(data, res)
if (!res.ok || unwrapped.code >= 400) {
if (res.status === 401 || res.status === 403 || unwrapped.code === 401 || unwrapped.code === 403) {
localStorage.removeItem('pb_manage_token')
localStorage.removeItem('pb_manage_logged_in')
localStorage.removeItem('pb_manage_login_account')
localStorage.removeItem('pb_manage_login_time')
window.location.replace('/pb/manage/login')
}
throw new Error(data.msg || '请求失败')
throw new Error(unwrapped.errMsg || '请求失败')
}
return data.data
return unwrapped.payload
}
async function parseJsonSafe(res) {
@@ -345,17 +373,18 @@ routerAdd('GET', '/manage/dictionary-manage', function (e) {
const parsed = await parseJsonSafe(res)
const data = parsed.json
if (!res.ok || !data || data.code >= 400) {
const unwrapped = unwrapApiResponse(data, res)
if (!res.ok || !data || unwrapped.code >= 400) {
if (res.status === 413) {
throw new Error('上传图片失败：文件已超过当前网关允许的请求体大小，或线上服务仍在运行旧版 hooks。')
}
if (!parsed.isJson && parsed.text) {
throw new Error('上传图片失败：服务端返回了非 JSON 响应，通常表示网关或反向代理提前拦截了上传请求。')
}
throw new Error((data && data.msg) || '上传图片失败')
throw new Error(unwrapped.errMsg || '上传图片失败')
}
return data.data
return unwrapped.payload
}
function escapeHtml(value) {

45
pocket-base/bai_web_pb_hooks/pages/document-manage.js
View File

@@ -708,6 +708,33 @@ routerAdd('GET', '/manage/document-manage', function (e) {
}
}
function decodeErrMsg(value) {
if (!value) {
return ''
}
try {
return decodeURIComponent(value)
} catch (_err) {
return String(value)
}
}
function unwrapApiResponse(data, res) {
const safe = data && typeof data === 'object' ? data : {}
const headerCode = Number(res && res.headers ? (res.headers.get('X-Status-Code') || 0) : 0)
const headerErrMsg = decodeErrMsg(res && res.headers ? res.headers.get('X-Err-Msg') : '')
const code = Number(safe.statusCode || safe.code || headerCode || 0)
const errMsg = safe.errMsg || safe.msg || headerErrMsg || ''
const hasLegacyEnvelope = Object.prototype.hasOwnProperty.call(safe, 'data')
&& (Object.prototype.hasOwnProperty.call(safe, 'code')
|| Object.prototype.hasOwnProperty.call(safe, 'statusCode')
|| Object.prototype.hasOwnProperty.call(safe, 'msg')
|| Object.prototype.hasOwnProperty.call(safe, 'errMsg'))
const payload = hasLegacyEnvelope ? (safe.data || {}) : safe
return { code: code, errMsg: errMsg, payload: payload }
}
async function requestJson(path, payload) {
const token = getToken()
if (!token) {
@@ -725,21 +752,22 @@ routerAdd('GET', '/manage/document-manage', function (e) {
})
const data = await res.json()
if (!res.ok || !data || data.code >= 400) {
if (res.status === 401 || res.status === 403 || data.code === 401 || data.code === 403) {
const unwrapped = unwrapApiResponse(data, res)
if (!res.ok || !data || unwrapped.code >= 400) {
if (res.status === 401 || res.status === 403 || unwrapped.code === 401 || unwrapped.code === 403) {
localStorage.removeItem('pb_manage_token')
localStorage.removeItem('pb_manage_logged_in')
window.location.replace('/pb/manage/login')
}
const details = data && data.data ? data.data : {}
const details = unwrapped.payload && typeof unwrapped.payload === 'object' ? unwrapped.payload : {}
const detailMessage = details.originalMessage || details.body || ''
const finalMessage = [(data && data.msg) || '请求失败', detailMessage].filter(function (item, index, arr) {
const finalMessage = [unwrapped.errMsg || '请求失败', detailMessage].filter(function (item, index, arr) {
return item && arr.indexOf(item) === index
}).join('：')
throw new Error(finalMessage || '请求失败')
}
return data.data
return unwrapped.payload
}
async function parseJsonSafe(res) {
@@ -797,7 +825,8 @@ routerAdd('GET', '/manage/document-manage', function (e) {
const parsed = await parseJsonSafe(res)
const data = parsed.json
if (!res.ok || !data || data.code >= 400) {
const unwrapped = unwrapApiResponse(data, res)
if (!res.ok || !data || unwrapped.code >= 400) {
if (res.status === 413) {
throw new Error('上传' + label + '失败：文件已超过当前网关允许的请求体大小，或线上服务仍在运行旧版 hooks。')
}
@@ -806,10 +835,10 @@ routerAdd('GET', '/manage/document-manage', function (e) {
throw new Error('上传' + label + '失败：服务端返回了非 JSON 响应，通常表示网关或反向代理提前拦截了上传请求。')
}
throw new Error((data && data.msg) || ('上传' + label + '失败'))
throw new Error(unwrapped.errMsg || ('上传' + label + '失败'))
}
return data.data
return unwrapped.payload
}
async function uploadPendingFiles(fileItems, label) {

36
pocket-base/bai_web_pb_hooks/pages/sdk-permission-manage.js
View File

@@ -245,6 +245,33 @@ routerAdd('GET', '/manage/sdk-permission-manage', function (e) {
}
}
function decodeErrMsg(value) {
if (!value) {
return ''
}
try {
return decodeURIComponent(value)
} catch (_err) {
return String(value)
}
}
function unwrapApiResponse(data, res) {
const safe = data && typeof data === 'object' ? data : {}
const headerCode = Number(res && res.headers ? (res.headers.get('X-Status-Code') || 0) : 0)
const headerErrMsg = decodeErrMsg(res && res.headers ? res.headers.get('X-Err-Msg') : '')
const code = Number(safe.statusCode || safe.code || headerCode || 0)
const errMsg = safe.errMsg || safe.msg || headerErrMsg || ''
const hasLegacyEnvelope = Object.prototype.hasOwnProperty.call(safe, 'data')
&& (Object.prototype.hasOwnProperty.call(safe, 'code')
|| Object.prototype.hasOwnProperty.call(safe, 'statusCode')
|| Object.prototype.hasOwnProperty.call(safe, 'msg')
|| Object.prototype.hasOwnProperty.call(safe, 'errMsg'))
const payload = hasLegacyEnvelope ? (safe.data || {}) : safe
return { code: code, errMsg: errMsg, payload: payload }
}
async function requestJson(path, payload) {
const token = getToken()
if (!token) {
@@ -263,18 +290,19 @@ routerAdd('GET', '/manage/sdk-permission-manage', function (e) {
})
const data = await res.json()
if (!res.ok || !data || data.code >= 400) {
if (res.status === 401 || res.status === 403 || data.code === 401 || data.code === 403) {
const unwrapped = unwrapApiResponse(data, res)
if (!res.ok || !data || unwrapped.code >= 400) {
if (res.status === 401 || res.status === 403 || unwrapped.code === 401 || unwrapped.code === 403) {
localStorage.removeItem('pb_manage_token')
localStorage.removeItem('pb_manage_logged_in')
localStorage.removeItem('pb_manage_login_account')
localStorage.removeItem('pb_manage_login_time')
window.location.replace('/pb/manage/login')
}
throw new Error((data && data.msg) || '请求失败')
throw new Error(unwrapped.errMsg || '请求失败')
}
return data.data
return unwrapped.payload
}
function roleOptionsHtml(selectedRoleId) {

256
pocket-base/spec/openapi-manage.yaml
View File

@@ -40,13 +40,13 @@ components:
schemas:
ApiResponse:
type: object
required: [code, msg, data]
required: [statusCode, errMsg, data]
properties:
code:
statusCode:
type: integer
description: "业务状态码"
example: 200
msg:
errMsg:
type: string
description: "业务提示信息"
example: 操作成功
@@ -343,13 +343,13 @@ components:
type: object
description: |
项目统一认证响应。
所有对外接口统一返回 `code`、`msg`、`data`，认证成功时额外返回顶层 `token`。
所有对外接口统一返回 `statusCode`、`errMsg`、`data`，认证成功时额外返回顶层 `token`。
properties:
code:
statusCode:
type: integer
description: "业务状态码"
example: 200
msg:
errMsg:
type: string
description: "业务提示信息"
example: 登录成功
@@ -370,8 +370,8 @@ components:
type: string
description: "PocketBase 原生 auth token；仅认证类接口在成功时额外返回"
example:
code: 200
msg: 登录成功
statusCode: 200
errMsg: 登录成功
data:
status: 登录或注册状态 | string
is_info_complete: 资料是否完整 | boolean
@@ -450,6 +450,14 @@ components:
type: string
description: "可选。未传 `users_phone_code` 时，可直接写入手机号"
example: '13800138000'
users_type:
type: string
description: "可选。用户类型；仅在传入非空值时更新"
example: 服务商
company_id:
type: string
description: "可选。公司业务 id；仅在传入非空值时更新"
example: WX-COMPANY-10001
users_tag:
type: string
description: "可选。用户标签；非空时才更新"
@@ -1194,13 +1202,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/HelloWorldData'
description: "业务响应数据"
$ref: '#/components/schemas/HelloWorldData'
/pb/api/system/health:
post:
tags: [系统]
@@ -1211,13 +1214,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/HealthData'
description: "业务响应数据"
$ref: '#/components/schemas/HealthData'
/pb/api/system/users-count:
post:
tags: [系统]
@@ -1229,13 +1227,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/UsersCountData'
description: "业务响应数据"
$ref: '#/components/schemas/UsersCountData'
/pb/api/platform/register:
post:
tags: [平台认证]
@@ -1292,8 +1285,8 @@ paths:
schema:
$ref: '#/components/schemas/PocketBaseAuthResponse'
example:
code: 200
msg: 登录成功
statusCode: 200
errMsg: 登录成功
data:
status: login_success
is_info_complete: false
@@ -1348,18 +1341,13 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DictionaryRecord'
description: "业务响应数据"
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DictionaryRecord'
'415':
description: "请求体必须为 application/json"
/pb/api/dictionary/detail:
@@ -1382,13 +1370,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/DictionaryRecord'
description: "业务响应数据"
$ref: '#/components/schemas/DictionaryRecord'
'400':
description: "参数错误"
'404':
@@ -1415,13 +1398,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/DictionaryRecord'
description: "业务响应数据"
$ref: '#/components/schemas/DictionaryRecord'
'400':
description: "参数错误或 dict_name 已存在"
'401':
@@ -1451,13 +1429,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/DictionaryRecord'
description: "业务响应数据"
$ref: '#/components/schemas/DictionaryRecord'
'400':
description: "参数错误或 dict_name 冲突"
'401':
@@ -1489,17 +1462,12 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
type: object
properties:
dict_name:
description: "字典名称，当前按全局唯一维护"
type: string
description: "业务响应数据"
type: object
properties:
dict_name:
description: "字典名称，当前按全局唯一维护"
type: string
'400':
description: "参数错误或删除失败"
'401':
@@ -1531,18 +1499,13 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/AttachmentRecord'
description: "业务响应数据"
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/AttachmentRecord'
'401':
description: "token 无效或已过期"
'403':
@@ -1568,13 +1531,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/AttachmentRecord'
description: "业务响应数据"
$ref: '#/components/schemas/AttachmentRecord'
'400':
description: "参数错误"
'401':
@@ -1605,13 +1563,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/AttachmentRecord'
description: "业务响应数据"
$ref: '#/components/schemas/AttachmentRecord'
'400':
description: "参数错误、缺少文件或附件保存失败"
'401':
@@ -1637,17 +1590,12 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
type: object
properties:
attachments_id:
description: "附件业务 ID"
type: string
description: "业务响应数据"
type: object
properties:
attachments_id:
description: "附件业务 ID"
type: string
'400':
description: "参数错误、附件已被文档引用或删除失败"
'401':
@@ -1681,18 +1629,13 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DocumentRecord'
description: "业务响应数据"
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DocumentRecord'
'401':
description: "token 无效或已过期"
'403':
@@ -1718,13 +1661,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/DocumentRecord'
description: "业务响应数据"
$ref: '#/components/schemas/DocumentRecord'
'400':
description: "参数错误"
'401':
@@ -1757,13 +1695,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/DocumentRecord'
description: "业务响应数据"
$ref: '#/components/schemas/DocumentRecord'
'400':
description: "参数错误、附件不存在或文档创建失败"
'401':
@@ -1796,13 +1729,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/DocumentRecord'
description: "业务响应数据"
$ref: '#/components/schemas/DocumentRecord'
'400':
description: "参数错误、附件不存在或修改失败"
'401':
@@ -1834,17 +1762,12 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
type: object
properties:
document_id:
description: "文档业务 ID"
type: string
description: "业务响应数据"
type: object
properties:
document_id:
description: "文档业务 ID"
type: string
'400':
description: "参数错误或删除失败"
'401':
@@ -1876,18 +1799,13 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DocumentHistoryRecord'
description: "业务响应数据"
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DocumentHistoryRecord'
'401':
description: "token 无效或已过期"
'403':
@@ -1895,3 +1813,5 @@ paths:
'415':
description: "请求体必须为 application/json"

57
pocket-base/spec/openapi-wx.yaml
View File

@@ -241,7 +241,7 @@ paths:
- 其他原生操作中，`update/delete/view` 仅管理员或管理后台用户允许
注意：
- 这是 PocketBase 原生返回结构，不是 hooks 统一 `{ code, msg, data }` 包装
- 这是 PocketBase 原生返回结构，不是 hooks 统一 `{ statusCode, errMsg, data }` 包装
- `company_id` 由数据库自动生成，客户端创建时不需要传
- `company_id` 仍带唯一索引，可用于后续按业务 id 查询
requestBody:
@@ -320,7 +320,7 @@ paths:
- 按需传 `page`、`perPage`
注意：
- 这是 PocketBase 原生返回结构，不是 hooks 统一 `{ code, msg, data }` 包装
- 这是 PocketBase 原生返回结构，不是 hooks 统一 `{ statusCode, errMsg, data }` 包装
- PocketBase 原生标准接口里，“按 `company_id` 查询单条”和“查询整个列表”共用同一个 `GET /records` 路径，因此文档以同一个 GET operation 展示两种调用模式
parameters:
- name: filter
@@ -539,7 +539,7 @@ paths:
- `page=1`
注意：
- 这是 PocketBase 原生返回结构，不是 hooks 统一 `{ code, msg, data }` 包装
- 这是 PocketBase 原生返回结构，不是 hooks 统一 `{ statusCode, errMsg, data }` 包装
- `attachments_link` 返回的是 PocketBase 文件字段值，不是完整下载地址
- 若需文件流地址，可按 PocketBase 标准文件路径自行拼接：`/pb/api/files/{collectionId}/{recordId}/{attachments_link}`
parameters:
@@ -660,7 +660,7 @@ paths:
- 若要按最新上传倒序，传 `sort=-document_create`
注意：
- 这是 PocketBase 原生返回结构，不是 hooks 统一 `{ code, msg, data }` 包装
- 这是 PocketBase 原生返回结构，不是 hooks 统一 `{ statusCode, errMsg, data }` 包装
- 如果需要更复杂的条件组合，可继续使用 PocketBase 原生 `filter` 语法自行扩展
parameters:
- name: filter
@@ -786,17 +786,17 @@ components:
ApiResponseBase:
type: object
required:
- code
- msg
- statusCode
- errMsg
- data
properties:
code:
statusCode:
type:
- integer
- string
description: "业务状态码"
example: 业务状态码 | integer
msg:
errMsg:
type: string
description: "业务提示信息"
example: 业务提示信息 | string
@@ -805,24 +805,24 @@ components:
type: object
additionalProperties: true
example:
code: 业务状态码 | integer
msg: 业务提示信息 | string
statusCode: 业务状态码 | integer
errMsg: 业务提示信息 | string
data:
任意业务字段: 业务响应数据 | object
ErrorResponse:
type: object
required:
- code
- msg
- statusCode
- errMsg
- data
properties:
code:
statusCode:
type:
- integer
- string
description: "业务状态码"
example: 业务状态码 | integer
msg:
errMsg:
type: string
description: "业务提示信息"
example: 失败原因提示 | string
@@ -831,8 +831,8 @@ components:
type: object
additionalProperties: true
example:
code: 业务状态码 | integer
msg: 失败原因提示 | string
statusCode: 业务状态码 | integer
errMsg: 失败原因提示 | string
data:
任意错误字段: 错误附加信息 | object
CompanyInfo:
@@ -1698,6 +1698,14 @@ components:
type: string
description: 可选。未传 `users_phone_code` 时，可直接写入手机号
example: '13800138000'
users_type:
type: string
description: 可选。用户类型；仅在传入非空值时更新
example: 服务商
company_id:
type: string
description: 可选。公司业务 id；仅在传入非空值时更新
example: WX-COMPANY-10001
users_tag:
type: string
description: 可选。用户标签；非空时才更新
@@ -1756,8 +1764,8 @@ components:
type: string
description: PocketBase 原生 auth token
example:
code: 业务状态码 | integer
msg: 业务提示信息 | string
statusCode: 业务状态码 | integer
errMsg: 业务提示信息 | string
data:
status: 登录或注册状态 | string
is_info_complete: 资料是否完整 | boolean
@@ -1835,8 +1843,8 @@ components:
description: "业务响应数据"
$ref: '#/components/schemas/WechatProfileResponseData'
example:
code: 业务状态码 | integer
msg: 业务提示信息 | string
statusCode: 业务状态码 | integer
errMsg: 业务提示信息 | string
data:
status: 资料更新状态 | string
user:
@@ -1908,8 +1916,8 @@ components:
type: string
description: 新签发的 PocketBase 原生 auth token
example:
code: 业务状态码 | integer
msg: 刷新成功 | string
statusCode: 业务状态码 | integer
errMsg: 刷新成功 | string
data: {}
token: 新签发的PocketBase原生auth token | string
UsersCountData:
@@ -1929,7 +1937,8 @@ components:
description: "业务响应数据"
$ref: '#/components/schemas/UsersCountData'
example:
code: 业务状态码 | integer
msg: 业务提示信息 | string
statusCode: 业务状态码 | integer
errMsg: 业务提示信息 | string
data:
total_users: 用户总数 | integer

269
pocket-base/spec/openapi.yaml
View File

@@ -33,13 +33,13 @@ components:
schemas:
ApiResponse:
type: object
required: [code, msg, data]
required: [statusCode, errMsg, data]
properties:
code:
statusCode:
type: integer
description: "业务状态码"
example: 200
msg:
errMsg:
type: string
description: "业务提示信息"
example: 操作成功
@@ -313,13 +313,13 @@ components:
type: object
description: |
项目统一认证响应。
所有对外接口统一返回 `code`、`msg`、`data`，认证成功时额外返回顶层 `token`。
所有对外接口统一返回 `statusCode`、`errMsg`、`data`，认证成功时额外返回顶层 `token`。
properties:
code:
statusCode:
type: integer
description: "业务状态码"
example: 200
msg:
errMsg:
type: string
description: "业务提示信息"
example: 登录成功
@@ -340,8 +340,8 @@ components:
type: string
description: PocketBase 原生 auth token；仅认证类接口在成功时额外返回
example:
code: 200
msg: 登录成功
statusCode: 200
errMsg: 登录成功
data:
status: 登录或注册状态 | string
is_info_complete: 资料是否完整 | boolean
@@ -420,6 +420,14 @@ components:
type: string
description: 可选。未传 `users_phone_code` 时，可直接写入手机号
example: '13800138000'
users_type:
type: string
description: 可选。用户类型；仅在传入非空值时更新
example: 服务商
company_id:
type: string
description: 可选。公司业务 id；仅在传入非空值时更新
example: WX-COMPANY-10001
users_tag:
type: string
description: 可选。用户标签；非空时才更新
@@ -1164,13 +1172,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/HelloWorldData'
description: "业务响应数据"
$ref: '#/components/schemas/HelloWorldData'
/pb/api/system/health:
post:
tags: [系统]
@@ -1181,13 +1184,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/HealthData'
description: "业务响应数据"
$ref: '#/components/schemas/HealthData'
/pb/api/system/users-count:
post:
tags: [系统]
@@ -1199,13 +1197,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/UsersCountData'
description: "业务响应数据"
$ref: '#/components/schemas/UsersCountData'
/pb/api/system/refresh-token:
post:
tags: [系统]
@@ -1235,8 +1228,8 @@ paths:
type: string
description: 新签发的 PocketBase 原生 auth token
example:
code: 200
msg: 刷新成功
statusCode: 200
errMsg: 刷新成功
data: {}
token: eyJhbGciOi...
'400':
@@ -1337,8 +1330,8 @@ paths:
schema:
$ref: '#/components/schemas/PocketBaseAuthResponse'
example:
code: 200
msg: 登录成功
statusCode: 200
errMsg: 登录成功
data:
status: login_success
is_info_complete: false
@@ -1395,13 +1388,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/WechatProfileResponseData'
description: "业务响应数据"
$ref: '#/components/schemas/WechatProfileResponseData'
'401':
description: token 无效或当前 auth record 缺少统一身份字段 openid
'400':
@@ -1426,18 +1414,13 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DictionaryRecord'
description: "业务响应数据"
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DictionaryRecord'
'415':
description: 请求体必须为 application/json
/pb/api/dictionary/detail:
@@ -1460,13 +1443,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/DictionaryRecord'
description: "业务响应数据"
$ref: '#/components/schemas/DictionaryRecord'
'400':
description: 参数错误
'404':
@@ -1493,13 +1471,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/DictionaryRecord'
description: "业务响应数据"
$ref: '#/components/schemas/DictionaryRecord'
'400':
description: 参数错误或 dict_name 已存在
'401':
@@ -1529,13 +1502,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/DictionaryRecord'
description: "业务响应数据"
$ref: '#/components/schemas/DictionaryRecord'
'400':
description: 参数错误或 dict_name 冲突
'401':
@@ -1567,17 +1535,12 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
type: object
properties:
dict_name:
description: "字典名称，当前按全局唯一维护"
type: string
description: "业务响应数据"
type: object
properties:
dict_name:
description: "字典名称，当前按全局唯一维护"
type: string
'400':
description: 参数错误或删除失败
'401':
@@ -1609,18 +1572,13 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/AttachmentRecord'
description: "业务响应数据"
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/AttachmentRecord'
'401':
description: token 无效或已过期
'403':
@@ -1646,13 +1604,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/AttachmentRecord'
description: "业务响应数据"
$ref: '#/components/schemas/AttachmentRecord'
'400':
description: 参数错误
'401':
@@ -1683,13 +1636,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/AttachmentRecord'
description: "业务响应数据"
$ref: '#/components/schemas/AttachmentRecord'
'400':
description: 参数错误、缺少文件或附件保存失败
'401':
@@ -1715,17 +1663,12 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
type: object
properties:
attachments_id:
description: "附件业务 ID"
type: string
description: "业务响应数据"
type: object
properties:
attachments_id:
description: "附件业务 ID"
type: string
'400':
description: 参数错误、附件已被文档引用或删除失败
'401':
@@ -1759,18 +1702,13 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DocumentRecord'
description: "业务响应数据"
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DocumentRecord'
'401':
description: token 无效或已过期
'403':
@@ -1796,13 +1734,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/DocumentRecord'
description: "业务响应数据"
$ref: '#/components/schemas/DocumentRecord'
'400':
description: 参数错误
'401':
@@ -1835,13 +1768,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/DocumentRecord'
description: "业务响应数据"
$ref: '#/components/schemas/DocumentRecord'
'400':
description: 参数错误、附件不存在或文档创建失败
'401':
@@ -1874,13 +1802,8 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
$ref: '#/components/schemas/DocumentRecord'
description: "业务响应数据"
$ref: '#/components/schemas/DocumentRecord'
'400':
description: 参数错误、附件不存在或修改失败
'401':
@@ -1912,17 +1835,12 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
type: object
properties:
document_id:
description: "文档业务 ID"
type: string
description: "业务响应数据"
type: object
properties:
document_id:
description: "文档业务 ID"
type: string
'400':
description: 参数错误或删除失败
'401':
@@ -1954,21 +1872,18 @@ paths:
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ApiResponse'
- type: object
properties:
data:
description: "业务响应数据"
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DocumentHistoryRecord'
description: "业务响应数据"
type: object
properties:
items:
type: array
items:
$ref: '#/components/schemas/DocumentHistoryRecord'
'401':
description: token 无效或已过期
'403':
description: 非 ManagePlatform 用户无权访问
'415':
description: 请求体必须为 application/json