一种应用程序编程接口文档的生成方法及装置与流程

专利检索2025-04-28  12


本申请涉及软件开发领域,具体涉及一种应用程序编程接口文档的生成方法及装置。


背景技术:

1、在现代软件开发中,应用程序编程接口(ap i)文档是不可或缺的,这些文档描述了ap i的描述、端点、参数和响应等相关信息,以便开发人员能够有效地使用ap i。

2、现有技术中,通常是通过手动撰写或文档生成工具来生成应用程序编程接口文档,其中手动撰写的方式通常耗时且容易出错;现有的文档生成工具需要用户具有高级技术知识,包括命令行操作或复杂的配置,使得文档转换过程相对繁琐,并且可能不允许用户灵活地自定义文档的样式和格式,限制了文档的个性化,此外部分工具可能仅适用于特定操作系统或开发环境,限制了它们的可用性。


技术实现思路

1、有鉴于此,本发明实施例所解决的技术问题之一在于提供一种应用程序编程接口文档的生成方法及装置,用以克服现有技术中应用程序编程接口文档的生成存在操作复杂、定制性不足、效率低下以及多平台兼容性不佳的问题。

2、本申请实施例第一方面公开一种应用程序编程接口文档的生成方法,所述方法包括:

3、对需制作应用程序编程接口文档的目标接口的请求会话进行录制,获得所述目标接口对应的第一会话数据;其中,所述第一会话数据用于记录全部请求对应的请求信息和响应信息;

4、对所述目标接口对应的所述第一会话数据进行第一信息提取处理,获得所述目标接口对应的第一接口文档数据;其中,所述第一接口文档数据用于记录接口名称、请求参数,以及所述请求参数对应的响应信息;

5、对所述目标接口对应的所述第一接口文档数据进行解释处理,获得所述目标接口对应的第二接口文档数据;其中,所述第二接口文档数据用于记录所述接口名称、所述请求参数,以及所述请求参数对应的参数解释和所述响应结果。

6、本申请实施例第二方面公开一种应用程序编程接口文档的生成装置,所述装置包括:

7、录制模块,用于对需制作应用程序编程接口文档的目标接口的请求会话进行录制,获得所述目标接口对应的第一会话数据;其中,所述第一会话数据用于记录全部请求对应的请求信息和响应信息;

8、信息提取模块,用于对所述目标接口对应的所述第一会话数据进行第一信息提取处理,获得所述目标接口对应的第一接口文档数据;其中,所述第一接口文档数据用于记录接口名称、请求参数,以及所述请求参数对应的响应信息;

9、解释处理模块,用于对所述目标接口对应的所述第一接口文档数据进行解释处理,获得所述目标接口对应的第二接口文档数据;其中,所述第二接口文档数据用于记录所述接口名称、所述请求参数,以及所述请求参数对应的参数解释和所述响应结果。

10、由本发明的以上
技术实现要素:
可见,本发明首先对需制作应用程序编程接口文档的目标接口的请求会话进行录制,获得目标接口对应的第一会话数据;然后对目标接口对应的第一会话数据进行第一信息提取处理,获得目标接口对应的第一接口文档数据;再对目标接口对应的第一接口文档数据进行解释处理,获得目标接口对应的第二接口文档数据。本发明基于对目标接口的请求会话进行录制及相应的信息提取和解释处理,可实现应用程序编程接口文档的自动生成,与现有技术相比,具有操作简单、效率高和可定制性强的特点,并且具有较好的多平台兼容性。



技术特征:

1.一种应用程序编程接口文档的生成方法,其特征在于,所述方法包括:

2.根据权利要求1所述的方法,其特征在于,当所述目标接口的数量为多个时,所述对所述目标接口对应的所述第一接口文档数据进行解释处理,获得所述目标接口对应的第二接口文档数据包括:

3.根据权利要求1或2所述的方法,其特征在于,所述第一接口文档数据和所述第二接口文档数据均采用markdown格式进行记录。

4.根据权利要求3所述的方法,其特征在于,所述对所述目标接口对应的所述第一接口文档数据进行解释处理,获得所述目标接口对应的第二接口文档数据之后,所述方法还包括:

5.根据权利要求1或2所述的方法,其特征在于,所述对需制作应用程序编程接口文档的目标接口的请求会话进行录制,获得所述目标接口对应的第一会话数据包括:

6.根据权利要求5所述的方法,其特征在于,所述对所述目标接口对应的所述第二会话数据进行json序列化处理,获得所述目标接口对应的所述第一会话数据包括:

7.根据权利要求5所述的方法,其特征在于,所述对所述目标接口对应的所述第二会话数据进行json序列化处理,获得所述目标接口对应的所述第一会话数据包括:

8.根据权利要求1所述的方法,其特征在于,所述对需制作应用程序编程接口文档的目标接口的请求会话进行录制,获得所述目标接口对应的第一会话数据包括:

9.根据权利要求8所述的方法,其特征在于,所述收到数据导出确认指示信号后,根据所录制的数据生成并导出所述目标接口对应的所述第一会话数据包括:

10.一种应用程序编程接口文档的生成装置,其特征在于,所述装置包括:


技术总结
本发明提供了一种应用程序编程接口文档的生成方法及装置,首先对需制作应用程序编程接口文档的目标接口的请求会话进行录制,获得目标接口对应的第一会话数据;然后对目标接口对应的第一会话数据进行第一信息提取处理,获得目标接口对应的第一接口文档数据;再对目标接口对应的第一接口文档数据进行解释处理,获得目标接口对应的第二接口文档数据。本发明基于对目标接口的请求会话进行录制及相应的信息提取和解释处理,可实现应用程序编程接口文档的自动生成,与现有技术相比,具有操作简单、效率高和可定制性强的特点,并且具有较好的多平台兼容性。

技术研发人员:阳水平,欧怀谷,王枭卿,丁倩
受保护的技术使用者:云盾智慧安全科技有限公司
技术研发日:
技术公布日:2024/5/29
转载请注明原文地址:https://win.8miu.com/read-1153142.html

最新回复(0)