最近调研了身边一些开发团队，发现他们列举的工具中，都出现过同一款工具——Eolink。
本文重点围绕以下产研需求展开（文末有福利）。
我选用的WebAPI框架是Flask，所以搭建Swagger需要用到Flasgger模块，如果你用FastAPI，可以不用多走这一步，直接使用FastAPI原生API文档即可。
使用Flasgger得到一个SwaggerUI具体步骤，不做重点描述，咱们的目标是打通Swagger和Eolink，让API研发资产可以盘活，Swagger简易部署流程请参考下述步骤。
首先安装flasgger模块。
pipinstallflasgger然后新建main.py文件，同时输入如下代码（本地Python版本为3.8），代码有点长，可以跳过阅读，直接复制代码到本地相应文件中。
作为一名合格的软件研发工程师，在公司团队协作开发的时候，一定要遵守团队API文档规范，边写代码，边写注释，边写文档。
在上述界面中，找到appispec_1.json超链接位置，点击该链接，页面跳转到Swagger生成的JSON文件地址，如下所示。
进入API管理控制台具体项目中，在左侧菜单栏找到【其它】，然后选择【API文档生成】。
可按下述动图进行操作。
在弹窗中选择通过SwaggerURL生成API文档，点击下一步：
上传前文获取的JSON文件到临时服务器，修改Swagger.json文件地址，点击确定，完成配置。
互联网公司项目，文档一般是支持外网访问的，这个问题只会在我们学习阶段碰到。
注意：上图右侧【完善配置】所有数据保持默认即可。
点击同步按钮，将Swagger文件内容同步到Eolink中。
再次切换到API列表页面，可以看到API同步之后的效果。
如果我们JSON文件发生了任意修改，例如【添加用户接口】新增加一个“年龄"参数，此时只需要点击上文提及的同步按钮，即可更新Eolink平台API详细数据。
这里咱们需要做一个小小的总结，在公司团队协作的场景下，经常出现文档和代码不同步情况，所以我们引入了Swagger模块，让小组中的程序员，在编写代码的同时，只需要更新自己的代码和注释，即可自动生成API文档。
但Swagger只是一个用于生成、描述和调用RESTful接口的Web服务，它远远无法满足团队中对于API的所有诉求，而Eolink在软件研发整个生命周期中，做了全方位的补充，从而盘活API研发资产。
除了手动点击【同步】操作外，我们还可以通过OpenAPI实现自动同步。
本篇博客中使用的是OpenAPIV2版本，在正式编写代码前，需要先在工作空间管理后台获取调用密钥。
密钥配置
点击在管理后台右上角头像位置的【账号设置】，进入工作空间设置菜单。
切换的页面中，选择【OpenAPI】，进入密钥配置。
为了数据安全，请不要将密钥泄露。点击上图箭头指向位置，查看密钥明细，直接点击即可复制。
解析来我们查看一下通过OpenAPI触发同步操作的请求说明。
有了这些标准之后，我们可以快速通过Python编写一个自动触发同步操作的脚本，代码如下。
{"type":"api","status":"success"}阅读到这里，我们已经实现了【通过OpenAPI触发同步操作】，你可以将代码部署到云服务器，并设置成自动任务，这样Eolink就可以实时的抓取服务端API文档，解放你的双手了。
Eolink除了手动同步和以OpenAPI形式同步文档以外，还可以通过IDEA插件实现快速在研发工具上操作并上传API接口文档，而且比Swagger的方式还快，具体步骤如下所示。
打开IDEA插件，再插件市场搜索EolinkApiKit。
点击上图的Install即可安装。
然后在你的项目源码空白处，点击树表右键，选择GenerateClassDoc，一键生成全部API注释文档。
生成完毕，再次选择UploadAllApi即可上传所有API注释到目标服务器，真正的一键生成文档，一键上传文档，如果你恰好使用的是IDEA，一定要尝试一下该方式，在Eolink的帮助下，写文档会变成一件非常轻松的事。
前文我们做的所有工作，都是为了让现有API文档快速生成并同步到Eolink中，只有这样，我们才能体验Eolink这个一站式API生产力工具，盘活API研发资产时的强大。
下面将借助刚刚建立的接口，为大家展示EolinkAPI智能生成请求代码和业务代码这一重点功能，过程中还将为大家介绍Eolink的一些小细节亮点。
API文档同步到Eolink，一切才刚刚开始！
选择进入前文同步的任意接口中，可以得到该接口的详细描述，更多内容可在你的Eolink后台查看，这里仅展示局部。
然后我们再看一个强大的功能，生成请求代码和业务代码，你可以借助Eolink生成指定API的各语言调用代码，操作非常便捷，只需要点击API文档详情页右上角“代码示例”图标即可。
这部分内置变量和内置函数，学习和使用时可以参考Eolink手册，点击阅读。
本篇博客，我们从Eolink与PythonFlaskSwagger文件打通开始，为大家介绍了两种Eolink同步API文档的方法，实战中还是建议大家在服务器端部署OpenAPI同步脚本，自动化实现Swagger和Eolink同步。
在同步的时候，我们可以进行更加详细的配置，扩展如下。
Eolink增加了非常详细的同步配置，多方面完善API文档更新细节。
除了API同步外，本文还给大家介绍了Eolink的几个亮点功能，例如自动生成预览数据，快速生成请求代码和业务代码，前置后置脚本添加。
审核编辑：李倩
原文标题：老油条用什么工具写文档？
长沙市望城经济技术开发区航空路6号手机智能终端产业园2号厂房3层（0731-88081133）