API 文档功能,让你效率翻倍

112 阅读1分钟

知乎上有一个热门问题:后端人员先开发后给文档合理吗?

我认为不合理,涉及到多人共同协作完成一件事的时候,不应该把设计任务只交给其中的某一个人,应该先交流和沟通,将设计的流程前置,并用文档记录设计的过程和结果。

就像开发人员总会吐槽产品文档没写清楚一样,前端人员也会吐槽后端不给文档或者写不清楚,这个问题可以通过引入一个能协作设计并展示清晰的 API 信息的工具解决。

你可以考虑在 Eoapi 尝试采用以下简易的协作流程:

  • 设计接口原型,写接口文档;

  • 前后端同步写代码,根据文档对接;

  • 在对接过程中获得的信息优化接口原型,重复过程。

下图可以让我们看到流程优化前后,效率是如何提高的

就这样,效率都提高了,前端、后端、测试都能准点下班了~

不妨试试

在线 Demo:

www.eoapi.io/?utm_source…

如果你觉得这个开源项目还可以的话,不妨点个 star 支持下他们,如果你觉得还需要继续优化,不妨去提个Issue.

Github:

github.com/eolinker/eo…

Gitee:

gitee.com/eolink\_adm…