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

摘要

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

主权项

1.一种API在线调试方法，其特征在于，该方法包括以下步骤：(1)生成API格式化描述：在使用Java语言进行软件开发时，开发人员使用标准的JavaDoc格式规范书写接口注释，并在API实现代码中加上自定义注解，使用API格式化描述生成工具对项目进行扫描，通过对项目中的类文件和源代码文件进行解析，根据解析得到的代码的JavaDoc格式的注释信息和自定义注解内容，获取API接口的注释和注解信息，并将获取到的注释和注解信息形成统一的API格式化描述；(2)API文档展示：在生成API格式化描述时，对API格式化描述生成工具配置API中心的访问地址和账户密码；API格式化描述生成工具将会自动将格式化后的API描述信息注册到API中心；API中心负责对所有的API文档进行统一管理，并拥有用户权限控制体系；API中心会对注册的API格式化描述进行持久化的处理，同时API中心会对API格式化描述进行解析，生成统一样式的API文档和Web页面并进行持久化处理；在查看API文档时，API中心直接展示API文档对应的Web页面；在对API文档进行修改后，API中心将会更新持久化的API格式化描述、API文档和对应的Web页面；(3)API在线调试：选择需要在线调试的API，填写API请求参数调试该API；API中心会将API调试请求转发给该API所属的项目的应用实例，并将调用结果返回至Web页面。