1:字段命令规范:所有字母小写,多个单词_分隔 例如用户名称:user_name
这样避免对接方因为字段命名大小写等问题导致获取不到字段值
2:一个成功请求和响应需要提供,方便调测
3:字段较多,建议添加字段和字段对应的注释
4:接口文档中的地址前缀部分 http://www.xxxx.com/ 建议使用domain变量,这样换了地址也不需要全部重新更新文档,测试代码同样建议用统一的变量实现
5:接口文档需要明确字段类型和字段是否必填,建议字段类型都是varchar类型,字段注释说明字段校验规则,长度限制