接口文档生成方法、系统和计算机可读存储介质技术方案

本公开提供了一种接口文档生成方法、系统和计算机可读存储介质，其中接口文档生成方法包括：从接口代码中提取接口的原始参数信息，所述原始参数信息包括多个原始参数；根据预先设置的映射模版对各所述原始参数进行参数解析，得到各所述原始参数的解释信息，所述映射模版包括不同字段及其对应的解释信息；根据各所述原始参数的所述解释信息生成接口文档。本公开的技术方案可在接口代码没有注解信息的情况下自动生成接口文档，可以极大减少人工干预成本，避免了生成接口文档时需要强依赖于注解信息的现象。解信息的现象。解信息的现象。

【技术实现步骤摘要】
接口文档生成方法、系统和计算机可读存储介质


[0001]本专利技术涉及计算机
，特别涉及一种接口文档生成方法、系统和计算机可读存储介质。

技术介绍

[0002]在接口开发过程中，开发人员需要提供完善的接口文档。接口文档的手工编写浪费了开发人员的开发时间，效率低且容易出错。而现有的自动化生成工具有些也需要手工编写配置文件，效率提升不够明显；另外，有些自动化生成工具需要引入额外的注解来标记接口，这种做法会对原有系统造成一定的侵入性。

技术实现思路

[0003]本专利技术旨在至少解决现有技术中存在的技术问题之一，提出了一种接口文档生成方法、接口文档生成系统和计算机可读存储介质。
[0004]第一方面，本公开实施例提供了一种接口文档生成方法，包括：
[0005]从接口代码中提取接口的原始参数信息，所述原始参数信息包括多个原始参数；
[0006]根据预先设置的映射模版对各所述原始参数进行参数解析，得到各所述原始参数的解释信息，所述映射模版包括不同字段及其对应的解释信息；
[0007]根据各所述原始参数的所述解释信息生成接口文档。
[0008]在一些实施例中，所述多个原始参数包括：请求参数和响应参数。
[0009]在一些实施例中，所述请求参数的数量为多个，所述响应参数的数量为多个；
[0010]在从接口代码中提取接口的原始参数信息的步骤之后且在根据预先设置的映射模版对各所述原始参数进行参数解析的步骤之前，还包括：
[0011]对多个所述请求参数进行数据层级树形结构的构建以得到请求参数之间的层级关系，以及对多个所述响应参数进行数据层级树形结构的构建以得到响应参数之间的层级关系；
[0012]所述接口文档内记载有所述请求参数之间的层级关系以及所述响应参数之间的层级关系。
[0013]在一些实施例中，对多个所述请求参数进行数据层级树形结构的构建的步骤包括：
[0014]利用临时表存储扁平化的多个所述请求参数，并利用递归法将扁平化的多个所述请求参数转换为树形结构；
[0015]对多个所述响应参数进行数据层级树形结构的构建的步骤包括：
[0016]利用临时表存储扁平化的多个所述响应参数，并利用递归法将扁平化的多个所述响应参数转换为树形结构。
[0017]在一些实施例中，在利用递归法将扁平化的多个所述请求参数或扁平化的多个所述响应参数转换为树形结构的过程中，若识别出当前待处理的所述请求参数或响应参数的
为泛型集合类参数且存在所述泛型集合类参数的测试数据时，则根据所述测试数据确定所述泛型集合类参数所对应节点的子节点。
[0018]在一些实施例中，所述多个原始参数包括：接口地址。
[0019]根据预先设置的映射模版对接口地址进行参数解析的步骤包括：
[0020]根据所述接口地址中的分隔符对所述接口地址进行分割，得到多个字符串；
[0021]使用所述映射模版对各所述字符串进行参数解析，得到各所述字符串的解释信息；
[0022]基于各所述字符串的解释信息得到所述接口地址的解释信息。
[0023]在一些实施例中，所述接口文档生成方法还包括：
[0024]从测试缓存中获取请求示例和/或响应示例；
[0025]将所述请求示例和/或所述响应示例记载于所述接口文档内。
[0026]在一些实施例中，所述多个原始参数包括：接口类型。
[0027]在一些实施例中，在根据各所述原始参数的所述解释信息生成接口文档的步骤之后，还包括：
[0028]响应于修改指令对所述接口文档进行相应修改。
[0029]第二方面，本公开实施例还提供了一种用于实现如第一方面中提供的所述方法的接口文档生成系统，包括：
[0030]提取模块，配置为从接口代码中提取接口的原始参数信息，所述原始参数信息包括多个原始参数；
[0031]解析模块，配置为根据预先设置的映射模版对各所述原始参数进行参数解析，得到各所述原始参数的解释信息，所述映射模版包括不同字段及其对应的解释信息；
[0032]生成模块，配置为根据各所述原始参数的所述解释信息生成接口文档。
[0033]第三方面，本公开实施例还提供了一种计算机可读存储介质，所述计算机可读存储介质中存储有计算机执行指令，当处理器执行所述计算机执行指令时，实现上述第一方面中提供的所述方法。
附图说明
[0034]图1为本公开实施例提供的一种接口文档生成方法的流程图；
[0035]图2为本公开实施例提供的另一种接口文档生成方法的流程图；
[0036]图3为本公开实施例提供的再一种接口文档生成方法的流程图；
[0037]图4为本公开实施例中对请求参数进行数据层级树形结构构建的一种示意图；
[0038]图5为本公开实施例中对响应参数进行数据层级树形结构构建的一种示意图；
[0039]图6为本公开实施例中生成接口文档的一种示意图；
[0040]图7为本公开实施例提供的再一种接口文档生成方法的流程图；
[0041]图8为本公开实施例所提供的一种接口文档生成系统的结构框图。
具体实施方式
[0042]为使本领域的技术人员更好地理解本专利技术的技术方案，下面结合附图对本专利技术提供的一种接口文档生成方法、接口文档生成系统和计算机可读存储介质进行详细描述。
[0043]图1为本公开实施例提供的一种接口文档生成方法的流程图，如图1所示，该接口文档生成方法包括：
[0044]步骤S1、从接口代码中提取接口的原始参数信息。
[0045]在开发人员完成应用程序接口(Application Programming Interface，简称API)的接口代码后，可基于接口代码提取出接口的原始参数信息，该原始参数信息包括多个原始参数。
[0046]在本公开实施例中，接口的原始参数信息是指在接口代码中用于描述接口属性的信息；例如，接口地址、接口类型、请求参数、响应参数。
[0047]其中，接口地址的本质为一个统一资源定位器(Uniform Resource Locator，简称URL)，用来唯一的标识一个资源，需求方可通过调用接口URL获取相应内容；接口类型(也称为请求方式)一般包括如下四种情况：Post(新增)、Put(修改)、Delete(删除)和Get(获取)；请求参数是指需要向接口请求的参数(本质为字段)；响应参数是指接口返回的参数(本质为字段)。
[0048]在实际应用中，可根据实际需要(例如，接口文档所需要记载的内容)来提取出所需要的原始参数信息。具体地，可通过一些现有的参数提取工具来进行原始参数信息的提取，或者是通过自定义提取算法来进行原始参数信息的提取。
[0049]步骤S2、根据预先设置的映射模版对各原始参数进行参数解析，得到各原始参数的解释信息。
[0050]其中，映射模版可进行预先设计和存储，映射模版包本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种接口文档生成方法，其特征在于，包括：从接口代码中提取接口的原始参数信息，所述原始参数信息包括多个原始参数；根据预先设置的映射模版对各所述原始参数进行参数解析，得到各所述原始参数的解释信息，所述映射模版包括不同字段及其对应的解释信息；根据各所述原始参数的所述解释信息生成接口文档。2.根据权利要求1所述的方法，其特征在于，所述多个原始参数包括：请求参数和响应参数。3.根据权利要求2所述的方法，其特征在于，所述请求参数的数量为多个，所述响应参数的数量为多个；在从接口代码中提取接口的原始参数信息的步骤之后且在根据预先设置的映射模版对各所述原始参数进行参数解析的步骤之前，还包括：对多个所述请求参数进行数据层级树形结构的构建以得到请求参数之间的层级关系，以及对多个所述响应参数进行数据层级树形结构的构建以得到响应参数之间的层级关系；所述接口文档内记载有所述请求参数之间的层级关系以及所述响应参数之间的层级关系。4.根据权利要求3中所述的方法，其特征在于，对多个所述请求参数进行数据层级树形结构的构建的步骤包括：利用临时表存储扁平化的多个所述请求参数，并利用递归法将扁平化的多个所述请求参数转换为树形结构；对多个所述响应参数进行数据层级树形结构的构建的步骤包括：利用临时表存储扁平化的多个所述响应参数，并利用递归法将扁平化的多个所述响应参数转换为树形结构。5.根据权利要求4所述的方法，其特征在于，在利用递归法将扁平化的多个所述请求参数或扁平化的多个所述响应参数转换为树形结构的过程中，若识别出当前待处理的所述请求参数或响应参数的为泛型集合类参数且存在所...

【专利技术属性】
技术研发人员：李昊，王保庆，白桦，杨立民，
申请(专利权)人：京东方科技集团股份有限公司，
类型：发明
国别省市：