[發明專利]一種接口文檔生成方法、系統、電子設備及存儲介質在審
| 申請號： | 202110830811.4 | 申請日： | 2021-07-22 |
| 公開（公告）號： | CN113672204A | 公開（公告）日： | 2021-11-19 |
| 發明（設計）人： | 肖光昭;高陽 | 申請（專利權）人： | 北京明略昭輝科技有限公司 |
| 主分類號： | G06F8/30 | 分類號： | G06F8/30;G06F8/71;G06F8/73;G06F9/445;G06F9/448 |
| 代理公司： | 青島清泰聯信知識產權代理有限公司 37256 | 代理人： | 李祺 |
| 地址： | 100089 北京市海淀區*** | 國省代碼： | 北京;11 |
| 權利要求書： | 查看更多 | 說明書： | 查看更多 |
| 摘要： | |||
| 搜索關鍵詞： | 一種 接口 文檔 生成 方法 系統 電子設備 存儲 介質 | ||
1.一種接口文檔生成方法，其特征在于，包括：
開發環境配置步驟，在一Java集成開發環境中配置EasyYapi插件；
規范框架配置步驟，在所述Java集成開發環境中的一Java項目中，添加一Swagger規范框架依賴，并將所述EasyYapi插件和所述Swagger規范框架依賴進行整合；
接口文檔生成步驟，通過所述EasyYapi插件上傳接口信息并在Yapi上生成接口文檔。
2.根據權利要求1所述的接口文檔生成方法，其特征在于，所述規范框架配置步驟進一步包括：在所述Java項目中，通過pom文件引入Swagger依賴，并在項目程序啟動入口Application上添加@EnableOpenApi注解，進一步在所述接口信息添加Swagger配置以添加所述Swagger規范框架依賴。
3.根據權利要求2所述的接口文檔生成方法，其特征在于，所述規范框架配置步驟進一步包括：所述Swagger配置包括注解@Api和@ApiOperation，其中，所述注解@Api用于接口大類，所述注解@ApiOperation用于具體接口。
4.根據權利要求1所述的接口文檔生成方法，其特征在于，所述接口文檔生成步驟進一步包括：若所述接口信息發生變更，則重復執行所述接口文檔生成步驟對所述Yapi上的所述接口文檔進行更新。
5.一種接口文檔生成系統，其特征在于，包括：
開發環境配置模塊，在一Java集成開發環境中配置EasyYapi插件；
規范框架配置模塊，在所述Java集成開發環境中的一Java項目中，添加一Swagger規范框架依賴，并將所述EasyYapi插件和所述Swagger規范框架依賴進行整合；
接口文檔生成模塊，通過所述EasyYapi插件上傳接口信息并在Yapi上生成接口文檔。
6.根據權利要求5所述的接口文檔生成系統，其特征在于，所述規范框架配置模塊進一步包括：在所述Java項目中，通過pom文件引入Swagger依賴，并在項目程序啟動入口Application上添加@EnableOpenApi注解，進一步在所述接口信息添加Swagger配置以添加所述Swagger規范框架依賴。
7.根據權利要求6所述的接口文檔生成系統，其特征在于，所述規范框架配置模塊進一步包括：所述Swagger配置包括注解@Api和@ApiOperation，其中，所述注解@Api用于接口大類，所述注解@ApiOperation用于具體接口。
8.根據權利要求5所述的接口文檔生成系統，其特征在于，所述接口文檔生成模塊進一步包括：若所述接口信息發生變更，則重復執行所述接口文檔生成模塊對所述Yapi上的所述接口文檔進行更新。
9.一種電子設備，包括存儲器、處理器以及存儲在所述存儲器上并可在所述處理器上運行的計算機程序，其特征在于，所述處理器執行所述計算機程序時實現如權利要求1至4中任一項所述的接口文檔生成方法。
10.一種計算機可讀存儲介質，其上存儲有計算機程序，其特征在于，該程序被處理器執行時實現如權利要求1至4中任一項所述的接口文檔生成方法。
該專利技術資料僅供研究查看技術是否侵權等信息，商用須獲得專利權人授權。該專利全部權利屬于北京明略昭輝科技有限公司，未經北京明略昭輝科技有限公司許可，擅自商用是侵權行為。如果您想購買此專利、獲得商業授權和技術合作，請聯系【客服】
本文鏈接：http://www.szxzyx.cn/pat/books/202110830811.4/1.html，轉載請聲明來源鉆瓜專利網。
