服务端之NestJS接口响应message编写规范详解、写给前后端都舒服的接口、API提示信息标准化

前言

在现代后端开发中，接口响应不仅仅是数据的传递，还承担着向前端或用户传递操作状态和结果的功能。一个规范、统一的message字段设计，可以显著提升系统的可维护性、前端开发效率和用户体验。

定义

响应结构示例（NestJS风格）

return {
    
    
    status: 200, // 可选，HTTP状态码
    message: '获取数据成功', // 提示信息
    data: {
    
    
        list, // 数据列表
        page: 1, // 当前页
        size: 10, // 每页数量
        total: list.length // 数据总数
    }
};

---

各字段作用

字段	类型	说明
status	number	HTTP或自定义状态码，用于程序判断
message	string	操作反馈信息，可显示给用户或用于日志
data	object	实际返回的数据对象，包含列表、分页或其他信息

提示信息设计原则

简洁明了
1、不宜过长，一般3~12个汉字。
2、避免含糊不清的词，如“完成了”、“OK”等。

---

统一风格
1、同一项目接口建议使用统一动词+状态组合，例如：获取数据成功、数据加载完成。

---

上下文清晰
1、提示信息应体现操作对象或类型，如“用户列表获取成功”而不是“获取成功”。

---

可扩展与模板化
1、对于多类型数据返回，可使用模板化语法：

message: `