2025年软件开发行业技术部程序员接口文档编写规范手册.docx

2025年软件开发行业技术部程序员接口文档编写规范手册

第1章接口定义与数据模型规范

1.1接口标准命名规则

接口命名必须严格遵循RESTful风格，采用小驼峰命名法（camelCase）将动词置于名词之前，以确保路径语义清晰且易于维护。例如，用户注册接口应命名为`registerUser`而非`RegisterUser`，请求参数接口命名为`registerUserRequest`，响应数据接口命名为`registerUserResponse`。为避免歧义，所有请求路径中的参数必须包含前缀`req`或`input`，而响应数据必须包含前缀`res`或`o