买专利卖专利找龙图腾，真高效！ 查专利查商标用IPTOP,全免费！专利年费监控用IP管家,真方便！

申请/专利权人：南威软件股份有限公司

摘要：本发明公开了基于swagger和word生成自定义api文档的方法，包括如下依次执行的步骤：S1：定义一个Word接口文档，所述Word接口文档中接口动态数据用占位符代替并传到minio上；S2：在系统工程中引入swagger相关的依赖包，配置swagger需要扫描的项目路径；S3：在开发系统工程的接口时，对swagger框架定义的api接口数据进行填写；以及步骤S4‑S11。本发明采用自动化流程，从swagger提供的api接口中自动提取openapi规范的所有api接口数据，然后将获取的api接口数据自动填充到自定义的Word接口文档中，消除了传统手动填写文档的繁琐性，同时也提高了文档生成的效率和准确性。

主权项：1.基于swagger和word生成自定义api文档的方法，其特征在于：包括如下依次执行的步骤：S1：定义一个Word接口文档，所述Word接口文档中接口动态数据用占位符代替并传到minio上；S2：在系统工程中引入swagger相关的依赖包，配置swagger需要扫描的项目路径；S3：在开发所述系统工程的接口时，对swagger框架定义的api接口数据进行填写；S4：在所述系统工程启动时，swagger自动扫描所述系统工程上的所有所述api接口数据，并分别将所述api接口数据封装成apenapi标准格式的数据并对外提供相应的api接口；S5：调用swagger提供的所述api接口，通过http请求获取得到openapi规范的所有所述api接口数据；S6：从S5生成的所有所述api接口数据中，提取所需要的api接口数据，过滤掉不需要的api接口数据，并将提取的api接口数据存储在所述系统工程中供后续处理；S7：通过所述minio下载S1定义的所述Word接口文档；S8：使用开源ApachePOI库来操作S7下载的所述Word接口文档，将S6提取的所述api接口数据填入所述Word接口文档中的相应位置；S9：以版本号来命名S8填充完成后的所述Word接口文档；S10：判断所述minio上是否有S9所命名的版本号的所述Word接口文档，如果有，则将其替换掉，否则，将所述Word接口文档上传到minio，并得到一个下载链接；S11：将S10得到的所述下载链接提供给需要对接的合作商，所述合作商只需要刷新就可以根据需求下载到对应的最新版本的所述Word接口文档。

全文数据：

权利要求：

百度查询： 南威软件股份有限公司 基于swagger和word生成自定义api文档的方法、系统及存储介质