7、在线接口文档沟通

项目场景:

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


问题描述

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


原因分析:

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


解决方案:

  1. 找一个在线文档
  2. 每次有修改,都告诉对方
  3. 如果涉及主键,外键等等这些,不要只截图,有时候截图会不全
  4. 双方的研发者都需要多沟通
  5. 多沟通,准没有错
  6. 可以讲解业务场景,或者接收数据之后,应该怎么做
  7. 最终拍板是对方,不是你
相关推荐
xieliyu.2 小时前
Java算法精讲:双指针(三)
java·开发语言·算法
明夜之约2 小时前
Spring Boot 自动装配源码
java·spring boot·后端
Leaton Lee2 小时前
Spring Boot分层架构详解:从Controller到Service再到Mapper的完整流程
java·spring boot·后端·架构
Jinkxs2 小时前
Resilience4j- 与 Spring Boot 快速集成:自动配置与基础注解使用
java·spring boot·后端
辣机小司2 小时前
【踩坑记录:Spring Boot 配置文件读取值不一致?警惕 YAML 的“八进制陷阱”与 SnakeYAML 版本之谜】
java·spring boot·后端·yaml·踩坑记录
fangdengfu1233 小时前
ES分析系统各个服务日志占用量
java·前端·elasticsearch
云烟成雨TD3 小时前
Spring AI 1.x 系列【51】可观测性技术选型
java·人工智能·spring
星越华夏3 小时前
ESP32-CAM图像传输项目说明文档
java·后端·struts·esp32
Jinkxs4 小时前
Java 跨域14-Java 与区块链(Hyperledger)集成
java·开发语言·区块链
晨曦中的暮雨5 小时前
Golang速通(Javaer版)
java·开发语言·后端·golang