7、在线接口文档沟通

项目场景:

新增多个接口,但是用离线版的word文档,进行沟通,如果对接口内容有更改,就会导致频繁的发送文档


问题描述

新增多个接口,但是用离线版的word文档,进行沟通,如果对接口内容有更改,就会导致频繁的发送文档


原因分析:

看项目要求,如果是研发者使用,可能会使用一些在线文档,但是大部分都是需要离线文档,进行存档的


解决方案:

  1. 找一个在线文档
  2. 每次有修改,都告诉对方
  3. 如果涉及主键,外键等等这些,不要只截图,有时候截图会不全
  4. 双方的研发者都需要多沟通
  5. 多沟通,准没有错
  6. 可以讲解业务场景,或者接收数据之后,应该怎么做
  7. 最终拍板是对方,不是你
相关推荐
华仔啊5 小时前
挖到了 1 个 Java 小特性:var,用完就回不去了
java·后端
SimonKing5 小时前
SpringBoot整合秘笈:让Mybatis用上Calcite,实现统一SQL查询
java·后端·程序员
日月云棠21 小时前
各版本JDK对比:JDK 25 特性详解
java
用户8307196840821 天前
Spring Boot 项目中日期处理的最佳实践
java·spring boot
JavaGuide1 天前
Claude Opus 4.6 真的用不起了!我换成了国产 M2.5,实测真香!!
java·spring·ai·claude code
IT探险家1 天前
Java 基本数据类型:8 种原始类型 + 数组 + 6 个新手必踩的坑
java
花花无缺1 天前
搞懂new 关键字(构造函数)和 .builder() 模式(建造者模式)创建对象
java
用户908324602731 天前
Spring Boot + MyBatis-Plus 多租户实战:从数据隔离到权限控制的完整方案
java·后端
桦说编程1 天前
实战分析 ConcurrentHashMap.computeIfAbsent 的锁冲突问题
java·后端·性能优化
程序员清风1 天前
用了三年AI,我总结出高效使用AI的3个习惯!
java·后端·面试