[发明专利]一种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页面。

2.根据权利要求1所述的一种API在线调试方法，其特征在于，所述步骤(1)中，所述API格式化描述生成工具通过使用JavaDocTool和Javassist工具，对项目的源代码和产生的类文件进行解析，根据解析得到的代码的JavaDoc格式的注释信息和自定义注解内容，获取API接口信息，并生成统一格式的JSON形式的格式化描述信息。

3.根据权利要求1所述的一种API在线调试方法，其特征在于，所述步骤(1)中，API接口信息包括接口的作者，开发日期，方法列表，以及方法的功能描述，方法的参数类型与名称，方法参数的描述信息，方法返回值类型与描述信息，方法可接受的请求类型与方法，方法的请求路径。

4.根据权利要求1所述的一种API在线调试方法，其特征在于，所述步骤(1)中，所述自定义注解包括以下几种：

@MseComponent：修饰接口，用于表明该接口对外提供非HTTP类型的服务；

@Api：修饰接口，通过author参数表明API开发者名称，date参数表明API开发日期，description参数表明API的描述信息；

@ApiMethod：修饰方法，通过type参数表明请求的类型，path参数表明请求的路径，description参数表明API的描述信息，response参数表明方法返回值的描述信息，methods参数表明可接受的请求方法，produces参数表明HTTP请求中的Accept信息，consumes表明HTTP请求中的Content‐Type信息。

@ApiParam：修饰方法参数，通过name参数表明参数名称，description参数表明参数描述信息，required参数表明参数是否必须；

@ApiModel：修饰类，用于方法参数中的自定义数据类型类，通过description参数表明类的描述信息；

@ApiModelField：修饰类中的域，用于方法参数中的自定义数据类型类中的域，通过type参数表明域的数据类型，description参数表明域的描述信息，required参数表明域是否必须；

所述JavaDoc格式的注释包括以下几种：

@author：表明作者；

@param：表明参数名称和参数描述信息；

@return：表明返回值名称和描述信息。

5.根据权利要求1所述的一种API在线调试方法，其特征在于，所述步骤(2)中，配置API格式化描述生成工具时，如果未配置API中心的访问地址和账户密码，则无法成功将API文档注册至API中心；如果未配置API文档对应的账户密码，则访问该API文档不需要验证用户身份。