前后端分离开发中,接口文档能提前给出来吗?

我司现在实现用前后端分离的方式开发项目,后端采用java进行开发,前端使用react进行开发,我作为公司的前端开发,开发项目时,我期望后端同学能在项目开发前花费几天的时间把项目api文档提前写出来,方便我模拟接口数据,进行前端开发,但后端的同学说不可能一开始把所有api文档搞出来(我们现在的项目开发大概十几个api接口,重复性的业务增删改查接口较多)。所以现在我们的项目开发就是:后端给一部分接口,前端再开发,后端给一部分,前端再开发,中间对api文档没有走前端、产品、UI的统一开会评审,最后导致开发过程中实际项目开发者之间产生很多的沟通问题。

因为我对java后台开发不甚了解,而且我司在前后端开发方式上经验不是很足,所以想问下各位前后端技术开发的同学:各位同学的公司在实现这种前后端分离开发中,具体走了哪些技术流程?还有我现在的这种问题有哪些方案可以优化?

阅读 10.2k
13 个回答

找后端拿页面碰一下,那些地方需要接口,从头锊一遍,大概也就1-2个小时最多,然后后端出一个接口文档,把所有要用到的字段先行定义出来,前端开发的时候使用接口文档中的字段.
前后端并行开发,遇到接口缺少字段双向同步增加.
后期联调的时候会比较方便,至少你不用再替换字段了.
很好用的,前提是你的后端比较靠谱,给你的接口文档是靠谱的,不然你会想死的心都有的.

这个就是项目流程的问题了,我们项目开发前会花一段时间来先做api评审,其实做完api评审后端的整个逻辑也就清晰了,前端也就不阻塞了,前端还可以自己根据api mock自己的数据,个人认为这种模式是一种很好的模式,我们目前也是按照这样的模式开发,推荐给大家

如果你们公司没有能够掌握整个项目的大牛,前后端都要靠自己的话
那么必须是前端先行,你让后台后台先写api岂不是为难他了?
如果有设计图的话,通过你们的沟通,后端也可以先写api,不然的话很难。

一切问题都是人的问题,前后端的负责人并没有把项目交付和提高开发当做自己的目标,而是我的活干完就行,不想背锅。先把前后端负责人思想摆正了,好的流程自然就会协商出来。前后端分离,不是前后端分家

淘宝出的 RAP, 可以方便的当接口文档使用,虽然不像普通文档那样,这个也能用起来的

一起商量下,根据业务需求需要啥接口,后端可以提前提供下文档呀,为啥不能,提供不了也没辙...并且前后端可以并行开发的。

可以的 提前给的接口文档 可以是一个先行版 和后端大概商量一下 先提供假接口定义数据结构 以不阻塞前端大部分开发为目的

项目出来不都是后端先提供整个项目的完整文档嘛...难道我是一个假后端??

后端先行没毛病,前提是需求要先细化且明确。如果在所有需求都明确的情况下,后端先行或两者并行都可以的。做项目配合,最怕的是程序员有态度问题,如果遇到这种情况,可以直接指出他的毛病(明示或者暗示),实在不行的话建议向领导反映。

感觉跟你们差不多,作为后端来说,能不能给出来完全是看需求能够细化到什么地步,重视需求,在开发前能够完全确定需求细节的项目完全可以提前给出接口规范,即使后期修改也只是小范围变动,非常方便。但是现实往往很多业务是需求只能定一个大概(尤其是非业务导向的项目),细节完全要靠开发时调整,那就只能先给一部分。

根据设计稿和原型,就知道自己需要什么数据,然后和后端协商传递的数据结构,然后后端给出文档后,在向他要假数据,自己本地mock,这样前后开发都不耽误。

项目经理,先定义处理接口文档,应该并给出结果返回示例(一般为json);分别交给移动端开发人员、前端web开发人员和后台接口实现人员。

如果没有给,不要怪罪于后台开发人员,这是团队开发协助没有管理好;也不要怪罪于你的领导,或许这项目没有争取到更多时间。

以后如果你(假设前端开发)接口定义和实现都熟悉了,拿到产品经理给出的移动端或者web端原型交互设计,你可以直接根据交互设计给出接口文档,交给你们的项目经理领导。

建议使用mock server,对代码没有侵入性,不用相互等

撰写回答
你尚未登录,登录后可以
  • 和开发者交流问题的细节
  • 关注并接收问题和回答的更新提醒
  • 参与内容的编辑和改进,让解决方法与时俱进
推荐问题
宣传栏