龙图腾网&IPTOP
- 微信扫码登录
- 账号密码登录
- 短信登录/注册
申请/专利权人：一网互通(北京)科技有限公司
申请日：2024-05-20
公开（公告）日：2024-06-18
公开（公告）号：CN118211569A
主分类号：G06F40/151
分类号：G06F40/151;G06F8/73
优先权：
专利状态码：在审-公开
法律状态：2024.06.18#公开
摘要：本发明实施例中提供了一种FLASK注释自动转成API文档方法、装置及电子设备，属于数据处理技术领域，该方法包括：创建包含接口路由存储表和接口返回数据结构表的数据库；获取所有路由地址的接口，并实时获取当前的路由地址；使用脚本获取项目路径，遍历项目路径下的所有代码文件，筛选出包含API接口的代码文件；编写注释解析器，识别FLASK应用程序中特定注释格式；设置存储函数，在每次请求处理完毕后将response数据存入数据库；编写自动运行脚本，在测试环境更新完代码后执行更新命令。本方案能够简化开发人员编写和维护API文档的工作量，提高开发效率和代码质量。
主权项：1.一种FLASK注释自动转成API文档方法，其特征在于，包括：创建包含接口路由存储表和接口返回数据结构表的数据库，所述接口路由存储表的字段包括：调用方法、接口名称、接口地址、接口所在文件地址以及参数及其描述，所述接口返回数据结构表的字段包括：接口地址、接口返回状态和返回数据；获取所有路由地址的接口，基于flaskurl_map.iter_rules方法实时获取当前的路由地址，用于和数据库里存入的接口进行对比，通过返回接口被调用过的所有response，来展示接口的数据结构状态码，根据路由存储表里存储的接口列表接口、数据结构接口以及FLASK接口路由接口，生成FLASK接口，并使用可视化API文档工具调用所述FLASK接口；使用脚本获取项目路径，遍历项目路径下的所有代码文件，筛选出包含API接口的代码文件；编写注释解析器，识别FLASK应用程序中特定注释格式，并提取与API相关的信息，遍历所有路由地址，使用注释解析器分析注释内容，提取接口相关信息，存入到数据库中；设置存储函数，在每次请求处理完毕后将response数据存入数据库，同时使用after_request装饰器将所述存储函数注册为钩子函数；编写自动运行脚本，在测试环境更新完代码后执行更新命令，通过配置所述自动运行脚本，使所述自动运行脚本在更新完代码后调用可视化API文档工具的接口，实现自动同步，进而实时自动生成API文档。
全文数据：
权利要求：
百度查询： 一网互通(北京)科技有限公司 FLASK注释自动转成API文档方法及装置
免责声明
1、本报告根据公开、合法渠道获得相关数据和信息，力求客观、公正，但并不保证数据的最终完整性和准确性。
2、报告中的分析和结论仅反映本公司于发布本报告当日的职业理解，仅供参考使用，不能作为本公司承担任何法律责任的依据或者凭证。
主营中国专利交易买卖与专利转让许可,高校科技成果推广与科技成果转化,知识产权运营管理与平台开发,科技人才专家库与科技猎头等科技服务
开放平台
担保交易
惠及多方
会员特惠
专属平台
适合多方
数据共享
功能齐全
皖公网安备 34010402703815号