ERPTurbo_Poster/lib/response.js
shenyifei dc940d2598 feat(api): 添加海报和PDF生成功能
- 新增海报生成接口,支持从网页URL或HTML内容生成海报图像
- 新增PDF生成接口,支持从网页URL或HTML内容生成PDF文档
- 添加Swagger API文档注释,完善接口描述和参数说明
- 实现HTML内容参数支持,允许直接传入HTML结构生成海报/PDF
- 添加输入验证和标准化响应格式
- 引入DOMPurify库对HTML内容进行安全过滤
- 更新环境变量配置,支持API密钥认证和CORS设置
- 优化上传逻辑,统一返回标准响应结构
- 添加构建脚本支持Docker镜像打包和推送
2025-11-20 17:51:35 +08:00

64 lines
1.7 KiB
JavaScript

/**
* Standardized Response Utilities
* Provides consistent response formatting for API endpoints
*/
/**
* Creates a standardized success response
* @param {*} data - The response data to include
* @param {string} message - Optional message about the operation
* @param {number} code - Optional response code (default: 200)
* @returns {Object} - Standardized success response
*/
function successResponse(data, message = 'Operation successful', code = 200) {
return {
success: true,
data: data,
message: message,
code: code
};
}
/**
* Creates a standardized error response
* @param {string} message - Error message
* @param {number} code - Optional error code (default: 400)
* @param {*} details - Optional error details
* @returns {Object} - Standardized error response
*/
function errorResponse(message, code = 400, details = null) {
return {
success: false,
data: null,
message: message,
code: code,
details: details
};
}
/**
* Helper function for parameter validation errors
* @param {string} message - Error message
* @param {number} code - Error code (default: 3001)
* @returns {Object} - Standardized parameter validation error response
*/
function validationErrorResponse(message, code = 3001) {
return errorResponse(message, code);
}
/**
* Helper function for internal server errors
* @param {string} message - Error message (default: "Internal server error")
* @param {number} code - Error code (default: 5000)
* @returns {Object} - Standardized internal server error response
*/
function serverErrorResponse(message = 'Internal server error', code = 5000) {
return errorResponse(message, code);
}
export {
successResponse,
errorResponse,
validationErrorResponse,
serverErrorResponse
};