汽车行业研发部软件工程师接口开发规范手册（执行版）.docxVIP

汽车行业研发部软件工程师接口开发规范手册（执行版）

第1章接口基础与通用原则

1.1接口定义与命名规范

接口定义必须基于RESTful风格或GraphQL语义，明确指定HTTP方法（GET/POST/PUT/DELETE）、请求路径（如`/api/v1/users`）及核心业务实体（如`User`,`Order`），避免使用非标准的自定义URL路径，确保开发、测试与运维团队对接口语义的理解一致。接口命名需遵循命名空间隔离原则，将业务模块（如`order`）与通用功能（如`auth`,`system`）分开，使用PascalCase命名类名（如`UserService`），并在路径中清晰体现版本前缀（如`/api/v1`），防止因新业务叠加导致的命名冲突。

接口参数必须严格区分输入参数与输出参数，输入参数采用camelCase命名（如`userId`），输出参数若包含复杂对象则使用驼峰命名（如`userDetail`），特殊符号（如``）仅用于标识JSON键名，严禁在路径或参数名中混用特殊字符。所有接口定义需在Swagger/OpenAPI2.0文档中集中维护，文档需包含完整的请求示例（RequestExample）与响应示例（ResponseExample），示例中应明确标注请求体（Body）的格式（如J