汽车行业技术部工程师接口文档编写手册.docxVIP

汽车行业技术部工程师接口文档编写手册

第1章

接口规范与版本管理

1.1接口定义标准与术语说明定义HTTP状态码”为接口反馈结果的唯一标准，其中2xx代表请求成功且数据已正确返回，3xx代表跳转或信息变更，4xx代表客户端请求错误，5xx代表服务端处理异常，任何接口返回必须严格遵循此映射表，不得人为修改。

明确JSON格式”作为数据交换的通用语言，规定所有接口响应必须返回UTF-8编码的JSON对象，包含完整的success布尔值字段，若业务逻辑失败则必须返回error对象及详细的message描述，禁止使用XML或纯文本格式。规定请求头（Headers）