[发明专利]一种API在线调试方法

说明书

本发明公开了一种API在线调试方法，开发人员使用标准的JavaDoc格式规范书写接口注释，并在API实现代码中加上自定义注解，使用API格式化描述生成工具对项目进行扫描，解析得到代码的JavaDoc格式的注释信息和自定义注解内容，形成统一API格式化描述，并注册至API中心；API中心负责对所有的API文档进行统一管理，对API格式化描述进行解析，生成统一样式的API文档和Web页面并进行持久化处理；用户通过客户端或浏览器访问相应的Web页面，即可阅读API文档，对API进行即时调试和测试。本发明方法在开发过程中不需要进行额外的工作和配置，即可自动生成API文档，通过统一的管理平台对API文档进行管理，并可以对不同类型的API进行在线调试，有效地提高接口开发效率和接口集成质量。

技术领域

本发明提供了一种在线调试API方法，主要涉及API展示与在线调试，可以帮助开发与测试人员更快速地进行API接口的调试与测试。

背景技术

随着软件业的快速发展，软件功能越来越强大，越来越多的应用服务将自身的资源开放给开发者来调用。应用服务对外提供的API使得不同应用之间的内容关联性更强，同时这些开放平台也为普通用户、开发者和中小企业带来了更大的价值。

一般情况下，API的描述是通过文档来维护的。但是静态文档仅能供使用者阅读，而不能进行在线调试。一旦API代码发生变更，则需要及时地更新和维护静态描述文档。目前市面上存在以Swagger为代表的一类API在线调试框架，虽然支持动态生成API文档和在线调试功能，但是动态API文档生成需要开发人员引入额外的Swagger依赖和配置，并对每一个API接口添加Swagger指定的注解和接口描述，与书写静态API描述文档相比没有显著减轻工作量，且较为繁琐。同时在线调试功能仅支持对HTTP接口进行调用。

为了解决这一系列弊端，提升接口集成效率，我们提出了一种API在线调试方法。软件开发人员在开发过程中不需要编写额外的代码和配置，就可以在应用部署后，通过访问统一的API管理平台，查看应用的API信息，并对不同类型的API进行调试。可以显著减少开发和测试人员工作量，提高软件开发效率和接口集成质量。

发明内容

本发明的目的在于针对现有技术的不足，提供一种API在线调试方法，使得计算机软件从业人员在软件开发过程中不需要完成额外的工作，就可以对不同类型的API进行查阅和调试，简化了软件开发过程中接口文档编写的工作量，提高了API接口的开发、测试和集成效率。

本发明是通过以下技术方案实现的：使用字节码文件解析工具和注释解析工具解析应用的接口信息，生成格式化的API文档和Web页面。用户通过客户端或浏览器访问相应的Web页面，即可阅读API文档，对API进行即时调试和测试。该方法具体包括以下步骤：

(1)生成API格式化描述。在使用Java语言进行软件开发时，开发人员使用标准的JavaDoc格式规范书写接口注释，并在API(支持包括HTTP、TCP、UDP在内的多种访问协议)实现代码中加上指定的注解，使用API格式化描述生成工具对项目进行扫描，通过对项目中的类文件和源代码文件进行解析，获取API接口的注释和注解信息，并将获取到的注释和注解信息形成统一的API格式化描述。

(1.1)API格式化描述生成工具是一个自研的工具，主要功能是通过使用JavaDocTool和Javassist工具，对项目的源代码和产生的类文件进行解析，根据解析得到的代码的JavaDoc格式的注释信息和自定义注解内容，获取API接口信息，并生成统一格式的JSON形式的格式化描述信息。在生成格式化的描述信息后，将会自动把API格式化描述信息注册至API中心。

(1.2)API接口信息包括接口的作者，开发日期，方法列表，以及方法的功能描述，方法的参数类型与名称，方法参数的描述信息，方法返回值类型与描述信息，方法可接受的请求类型与方法，方法的请求路径。

(1.3)自定义注解包括以下几种：