接口文档是开发接口之前写还是开发之后写？

Question

因为有个需求要和公司别的项目对接，他们需要调用我们写给他们的接口,我们需要提供接口文档给那个项目组，因为没写过，所以产生了这样的问题。接口文档是开发接口之前写还是开发之后写，或者说是开发前先写一个初稿，然后开发过程中在进行补充？

Answer 1

我们的做法是：
1.前后端先过需求，然后制定出需要哪些接口，制定接口规范
2.服务端给出json报文，标明各个字段含义，并给出模拟api
3.然后客户端就可以开始先做功能，调用模拟api
4.前后端开发大体完成，进入集成测试，期间接口会做加减法，但是变动不大

以上，是基于有个好的架构负责梳理业务流程，毕竟先给出接口文档和模拟API的是对业务流程把握的考验，
开发期间，有问题应该主动沟通，或者是每天上班开个几分钟晨会，报一下进度，还有反馈可能觉得出现的情况。

Answer 2

先写接口后写文档。

写文档的同时你可能会发现有哪些逻辑不对。

接口文档建议使用swagger

Answer 3

当然是开发完后写啊。你是开发者，和你对接的是需求在。假如你给个文档还没出接口，别人拿着有啥用。而且接口会变动。所以先写好接口，然后更新文档给你对接公司。

Answer 4

1.建议之后写
2.科学的方法是一边开发，一边书写，移动端可以准确书写

Answer 5

先把接口都写好，再更新文档

Answer 6

前后端交流确定需要那些接口，然后写接口，在写文档