【技术实现步骤摘要】
本专利技术涉及移动开发，具体为一种基于插件和ai流编排的接口文档生成方法及系统。
技术介绍
1、传统的接口文档编写工具，通常需要开发人员手动编写和维护大量的注解，并且在处理没有明确注解的代码部分、适应多语言环境和复杂项目架构方面存在限制。
2、目前，对于生成接口文档，存在以下技术问题：
3、(1)开发人员需要花费大量时间和精力为每个接口、参数和返回值编写注解，增加了开发成本；当接口发生变更时，开发人员还需要同步更新文档中的注解，增加了维护的复杂性；
4、(2)传统的接口文档编写工具无法提供灵活且个性化的接口文档生成设置。
技术实现思路
1、本专利技术的目的在于提供一种基于插件和ai流编排的接口文档生成方法及系统，以解决上述
技术介绍
中提到的现有的开发成本高、无法提供个性化的接口文档生成设置等问题。
2、为实现上述目的，本专利技术采用以下技术方案：
3、根据本专利技术的一个方面，提供一种基于插件和ai流编排的接口文档生成方法，所述方法包括：
4、使用插件解析源代码中特定的注解，提取接口信息并格式化为结构化的第一数据文件；
5、在ai流中的python节点读取所述第一数据文件，进行数据预处理，生成第二数据文件；
6、根据输入的接口文档模板参数，使用分解算法将所述接口信息映射到所述接口文档模板的对应内容；
7、在所述ai流中的llm节点输入所述接口文档模板和所述第二数据文件，生成第一
8、对所述第一接口文档进行校对和优化，输出第二接口文档。
9、基于前述方案，使用ide的api接口访问并解析所述源代码，采用反射机制或解析库进行读取和解析所述注解，应用序列化库将所述接口信息转换为所述第一数据文件。
10、基于前述方案，所述接口信息包括但不限于接口相关的名称、对象信息等元数据、方法名、参数列表、返回类型、注解描述。
11、基于前述方案，根据所述第二数据文件提取接口关键信息，调用所述分解算法解析所述接口文档模板，识别占位符并将所述接口关键信息动态映射至所述占位符上。
12、基于前述方案，所述接口文档模板为自定义模板，定义所述接口文档模板的基本结构，包括但不限于接口名称、请求方法、请求url、请求参数、响应参数、状态码、错误码。
13、基于前述方案，所述生成第一接口文档，包括所述python节点将所述第二数据文件分为多个分段数据，所述llm节点根据所述分段数据和所述接口文档模板，生成对应的基于所述分段数据的接口文档内容，并填充到所述接口文档模板中，形成所述第一接口文档。
14、基于前述方案，所述生成第一接口文档，包括调用所述llm节点时使用prompt提示词生成所述接口文档模板相应的文本内容。
15、根据本专利技术的另一方面，提供一种基于插件和ai流编排的接口文档生成系统，该系统包括：
16、注解解析模块，ai流编排模块；所述ai流编排模块包括python节点，llm节点；
17、所述注解解析模块使用插件解析源代码中特定的注解，提取接口信息数据；所述python节点读取所述接口信息数据并分为分段数据；所述llm节点根据所述分段数据生成对应的文本内容。
18、基于前述方案，所述llm节点输入接口文档模板和所述分段数据，输出所述接口文档模板对应的文本内容。
19、基于前述方案，将所述llm节点生成的所述文本内容填充至所述接口文档模板中，进行校对和优化后生成接口文档文件。
20、由上述技术方案可知，本专利技术与现有技术相比至少具备以下优点和积极效果：
21、(1)使用插件方式自动识别并解析源代码中的注解，从而精准提取接口信息数据，相较于传统的手动重复操作，这一方法显著简化了操作流程，极大提升了工作效率；
22、(2)通过引入ai流编排技术，自动化程度大大提高，不仅减少了手动编写和维护文档的繁琐工作，还显著提升了文档的质量，包括内容的准确性和语言的流畅性，为用户提供更为个性化和智能化的文档生成方案。
23、本专利技术应当理解的是，以上的一般描述和后文的细节描述仅是示例性和解释性的，并不能限制本专利技术。
本文档来自技高网...【技术保护点】
1.一种基于插件和AI流编排的接口文档生成方法，其特征在于，所述方法包括：
2.根据权利要求1所述的一种基于插件和AI流编排的接口文档生成方法，其特征在于，使用IDE的API接口访问并解析所述源代码，采用反射机制或解析库进行读取和解析所述注解，应用序列化库将所述接口信息转换为所述第一数据文件。
3.根据权利要求1所述的一种基于插件和AI流编排的接口文档生成方法，其特征在于，所述接口信息包括但不限于接口相关的名称、对象信息等元数据、方法名、参数列表、返回类型、注解描述。
4.根据权利要求1所述的一种基于插件和AI流编排的接口文档生成方法，其特征在于，根据所述第二数据文件提取接口关键信息，调用所述分解算法解析所述接口文档模板，识别占位符并将所述接口关键信息动态映射至所述占位符上。
5.根据权利要求1所述的一种基于插件和AI流编排的接口文档生成方法，其特征在于，所述接口文档模板为自定义模板，定义所述接口文档模板的基本结构，包括但不限于接口名称、请求方法、请求URL、请求参数、响应参数、状态码、错误码。
6.根据权利要求1所述的
7.根据权利要求1所述的一种基于插件和AI流编排的接口文档生成方法，其特征在于，所述生成第一接口文档，包括调用所述LLM节点时使用prompt提示词生成所述接口文档模板相应的文本内容。
8.一种基于插件和AI流编排的接口文档生成系统，其特征在于，包括注解解析模块，AI流编排模块；所述AI流编排模块包括Python节点，LLM节点；
9.根据权利要求8所述的一种基于插件和AI流编排的接口文档生成系统，其特征在于，所述LLM节点输入接口文档模板和所述分段数据，输出所述接口文档模板对应的文本内容。
10.根据权利要求9所述的一种基于插件和AI流编排的接口文档生成系统，其特征在于，将所述LLM节点生成的所述文本内容填充至所述接口文档模板中，进行校对和优化后生成接口文档文件。
...【技术特征摘要】
1.一种基于插件和ai流编排的接口文档生成方法，其特征在于，所述方法包括：
2.根据权利要求1所述的一种基于插件和ai流编排的接口文档生成方法，其特征在于，使用ide的api接口访问并解析所述源代码，采用反射机制或解析库进行读取和解析所述注解，应用序列化库将所述接口信息转换为所述第一数据文件。
3.根据权利要求1所述的一种基于插件和ai流编排的接口文档生成方法，其特征在于，所述接口信息包括但不限于接口相关的名称、对象信息等元数据、方法名、参数列表、返回类型、注解描述。
4.根据权利要求1所述的一种基于插件和ai流编排的接口文档生成方法，其特征在于，根据所述第二数据文件提取接口关键信息，调用所述分解算法解析所述接口文档模板，识别占位符并将所述接口关键信息动态映射至所述占位符上。
5.根据权利要求1所述的一种基于插件和ai流编排的接口文档生成方法，其特征在于，所述接口文档模板为自定义模板，定义所述接口文档模板的基本结构，包括但不限于接口名称、请求方法、请求url、请求参数、响应参数、状态码、错误码。
6.根据权利要求1所述的一种基...
【专利技术属性】
技术研发人员：肖弘华，孟祥锐，唐志兴，陈誉，程祝国，
申请(专利权)人：深圳市银雁科技有限公司，
类型：发明
国别省市：
还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。