接口文档明细表

接口文档明细表文档版本：V1.0更新日期：______年____月____日编写人：____________审核人：____________适用系统：________________________接口环境：□开发□测试□预发□生产协议类型：□HTTP□HTTPS□WebSocket一、接口基础信息本表用于标准化记录接口全量信息，保障前后端、第三方对接顺畅，便于调试、维护及迭代升级，所有字段需据实填写，确保无歧义、可落地。序号接口名称接口标识（ID）请求地址（URL）请求方式请求格式响应格式接口状态备注1□GET□POST□PUT□DELETE□PATCH□form-data□x-www-form□json□xml□json□xml□text□待开发□开发中□已上线□已废弃2□GET□POST□PUT□DELETE□PATCH□form-data□x-www-form□json□xml□json□xml□text□待开发□开发中□已上线□已废弃3□GET□POST□PUT□DELETE□PATCH□form-data□x-www-form□json□xml□json□xml□text□待开发□开发中□已上线□已废弃4□GET□POST□PUT□DELETE□PATCH□form-data□x-www-form□json□xml□json□xml□text□待开发□开发中□已上线□已废弃二、接口请求参数明细所属接口参数名称参数类型是否必填参数说明默认值示例值约束规则□String□Int□Float□Boolean□Array□Object□是□否□String□Int□Float□Boolean□Array□Object□是□否□String□Int□Float□Boolean□Array□Object□是□否填写说明：约束规则需注明长度限制、枚举值、格式要求（如手机号、日期格式）、校验逻辑等；请求头参数（Token、Content-Type）需单独补充至备注栏三、接口响应参数明细所属接口字段名称字段类型字段说明必填性成功示例备注codeInt响应状态码是200全局统一msgString响应提示信息是请求成功全局统一dataObject/Array业务数据体否{}无数据返回空□是□否四、状态码与异常处理状态码英文标识含义说明触发场景处理建议200SUCCESS请求成功正常调用正常解析数据400PARAM_ERROR参数错误必填项缺失、格式非法校验请求参数后重试401UNAUTHORIZED未授权/令牌失效Token过期、无权限重新登录获取令牌404NOT_FOUND接口不存在URL错误、接口下线核对接口地址500SERVER_ERROR服务器异常后台服务报错联系开发人员排查五、调用示例与补充说明5.1请求示例（JSON格式）json

{

"userId":1001,

"userName":"test",

"pageNum":1,

"pageSize":10

}5.2成功响应示例（JSON格式）json

{

"code":200,

"msg":"请求成功",

"data":{

"total":50,

"list":[]

}

}5.3补充说明接口调用频率限制：________________次/秒，超出限制返回429状态码加密要求：□无□MD5加密□AES加密□RSA加密，加密字段：________________跨域配置：□支持□不支持超时时间：________________秒其他特殊说明：________________________________________________________________六、版本更新记录版本号更新日期更新内容更新人审核状态V1.0初始文档创建□待审核□已通过□已驳回□待审核□已通过□已驳回注意事项接口文档需实时同步更新，接口修改、新增、废弃后及时修订对应字段，确保对接方获取最新信息。参数名称、类型、约束规则需精准填写，避免模糊表述，示例值贴合真实业务场景，便于调试。全局状态码、响应格式保持统一，特殊接口的个性化配置需单独标注，降低对接成本。接口调试、联调过程中发现问题及时记录并更新文档，所有修改