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

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

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


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

技术介绍

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

技术实现思路

[0003]本专利技术旨在至少解决现有技术中存在的技术问题之一，提出了一种接口文档生成方法、接口文档生成系统和计算机可读存储介质。
[0004]第一方面，本公开实施例提供了一种接口文档生成方法，包括：
[0005]从接口代码中提取接口的原始参数信息，所述原始参数信息包括多个原始参数；
[0006]根据预先设置的映射模版对各所述原始参数进行参数解析，得到各所述原始参数的解释信息，所述映射模版包括不同字段及其对应的解释信息；
[0007]根据各所述原始参数本文档来自技高网...

【技术保护点】

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

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