也许小型程序员现在听说有些人使用单词来制作接口文档，但他们会感到惊讶，但是在前端分离的早期阶段，确实没有太多易于使用的接口文档工具。
互联网已经开发到现在，界面文档也已经通过简单的单词向HTML，招摇，apifox等，它们变得越来越美丽，越来越标准化，并支持越来越多的功能性帮助调试调试措施
接下来，我将研究这些年的界面文档的进化过程。
一开始，前后是分开的，后端必须告知前端接口的信息，以便利前端的呼叫。您需要提供的信息也是需要书面的信息在Word中，因此有这样的接口文档：
这个问题似乎已经解决，但是该项目经常修改和迭代，这将导致：
该界面文档在项目中经常更改。每次更新，您都需要向项目成员分发新接口文档
因此：A。每次更改它时，都需要创建新副本并将其复制到项目团队中的许多人。这样的文件被复制和复制。由于项目团队中有这么多人，没人知道这是否是新版本。
B.如果您更改一点，则需要生成新文档，因此文件夹中的接口文档可能是此表格：
谁哭了，我不会说。
这些痛点有助于接口文档的第一个演变：从接口文档的单词版本演变为接口文档的Web版本。
接口文档的Web版本非常完美，只有一个链接需要分配给项目成员。
这样，如果在网页中修改了后端并直接修改了后端，则可以保证每个人都看到最新版本，并且您不必每次更改它时都向所有人发送新文档。
这样的静态HTML页面由Markdown生成，接口的关键元素都可用
问题解决了！
但是 - 新问题再次出现。
可以使用此接口文档，但是它并不容易使用，例如：
1.写作界面非常麻烦，完全手写，没有任何辅助工具，需要时间
2.编写接口后，您无法立即看到生成的接口文档的效果。
3.没有接口规范约束，如何编写接口文档，编写哪些参数，未编写的参数，并且演示表格基于开发人员本身的业务级别。
因此，新的进化开始了 - 某些人开发了一种专门用于编写接口文档的工具。
如何编写？在Swagger编辑器中，编写一个符合Swagger语法以生成接口文档的接口文档。编译的接口文档可以在Swagger Editor的右侧预览：
结果，演变为此完整阶段的接口文档工具已达到以下功能：
1.由接口文档的Web版本支持的在线查看功能。当然，他还拥有它，并且该接口文档的样式符合Open API3.0规范。如果不是用语法编写的，那么Swagger编辑器还将报告一个错误以纠正您。
标准接口应具有信息：接口方法，接口路径，请求和响应参数，可以以固定格式呈现。
2.它还具有初步和简单的调试函数，即接口请求参数是空间。填写参数并发送请求以返回响应参数
看来这已经足够了，对吗？
但是 - 等待，如果这些可以开发自己，但是如果您想在项目中使用它，那么许多界面文档都很难管理。Swagger编辑不提供项目级别的档案和管理。维护也很麻烦
此外，到目前为止，还没有逃脱界面文档可以依靠手写的命运和学习宣传注释。通过这种方式，学习成本可用，工作效率将无法提高。
生成的接口文档，前端需要使用接口信息来调试页面，并且测试将使用它来验证接口。但是，接口文档的当前功能不足以支持前端和测试工作?
似乎更完美？
将有带有疼痛点的解决方案，因此接口文档开始了新的进化道路。
想要团队合作吗？安排。我可以在不编写代码的情况下生成接口文档吗？可以直接在接口文档上调整接口吗？支持。界面没有在生产环境上，但是如果您要模拟数据，可以您调试首页？支持。希望直接使用接口数据执行自动测试？安排。
因此，最终进化形式中的接口文档工具诞生了。
首先是优化现有接口文档的功能：A。一个视觉接口设计页面，而无需编写Swagger注释，填写要保存的参数是接口文档。
只要您了解界面的知识，就可以编写它。
接口文档编辑状态
接口文档仅读取状态
B.一个单击导出接口文档，仅支持共享接口文档的一部分，设置到期时间，设置密码
C.接口文档实时更新。一旦更改接口文档，数据将与所有参与项目的成员同步
第二个是添加前端并测试疯狂的插件-A。接口文档页面以支持在线调试
共享接口文档页面以支持简单的基本调试功能。如果您想更强大地调试帮助，则可以使用Apifox客户端。
客户端的调试函数已在提取变量，断言和数据库上视觉封装。不需要脚本。如果有复杂的调试需求，则仍然支持脚本调试功能
B.也有许多类型的代码支持生成代码，包括前后常用的各种语言和框架。总共有130多种类型。JavaScript，Swift，Java等可以由生成的前端代码使用。
它不仅支持生成接口请求代码，还支持生成数据模型代码。可以根据需要生成整个项目的代码，然后单独进行调整。这样，您需要编写的代码数量大大减少了。
F.在未启动界面时提供模拟环境，该界面还可以模拟接口请求，为前端测试页面构建高度现实的业务数据，后端 - 端和测试接口调试和测试
您可以将链接复制到浏览器以查看生成的在线文档：
https://www.apifox.cn/apidoc/shared-cbb5c14c14c14c14c14d-9f6e-7027cd5702/api-21636796
最后，将界面的整个工作链集成到其工具中：A。支持项目级别的协作
每个接口属于不同的模块，并将其分为不同的目录。后端，前端和测试可以使用相同的接口数据源，这意味着在创建接口后，在其上保持了后端。前端将他用作接口模拟，将其作为接口自动化进行测试，并且数据更改是实时与每个端同步的。无需切换多个软件。
B.支持引入20多种格式的接口数据等。
C.以Swagger，HTML，单词格式和未绑架的用户支持接口文档。如果您想迁移到其他系统，那就很棒了。
这样的拳头组合，基本上您可以拥有可以想到的功能。
官方网站地址：https：//www.apifox.cn/a1volution
因此，总而言之，界面文档一直在不断发展，战斗效率变得越来越强。它还为研发人员提供了越来越多的帮助，以便他们可以编写较少的不必要的代码，做较少的重复工作，并做较少的重复工作。效法您可以根据项目的实际情况选择正确的工具。
原始：https：//juejin.cn/post/7121968297880322062