[发明专利]一种基于JSON解析的开放平台接口文档自动生成方法及系统

说明书

本发明涉及一种基于JSON解析的开放平台接口文档自动生成方法及系统，该方法包括以下步骤：步骤A：JSON源数据系统生成接口文档JSON数据；步骤B：JSON解析引擎解析接口文档JSON数据并生成接口文档最终数据；步骤C：接口文档管理系统校验接口文档最终数据的完整性和合法性，若校验通过执行步骤D；步骤D：接口文档管理系统存储通过校验的接口文档最终数据。本发明优点：本发明基于JSON解析的方式实现接口文档的自动生成，使得该接口文档自动生成技术更加通用。本发明将生成的接口文档最终数据持久化存储，保证文档不易丢失，为软件开发提供保障。本发明提供的接口文档自动生成技术，减少了人工的介入，提高了接口文档的准确性，提高了软件开发的效率。

技术领域

本发明属于计算机技术领域，具体涉及基于JSON解析的开放平台接口文档自动生成技术。

背景技术

随着互联网的不断发展，在当下互联网时代，把一系列服务封装为数据接口开放出去的技术性开放已经成为各大互联网公司的未来战略，互联网大厂将自己的技术开放出去，供第三方开发者使用，第三方开发者基于这些开放的接口能力开发各种丰富多彩的应用，第三方开发者在调用这些接口时，是需要提供相应的接口文档知道开发者进行调用的，然后，接口文档的撰写与维护需要消耗大量的人力资源。

公开号为“CN110244945A”的中国专利文献公开了名称为“接口文档生成方法及终端设备”的技术，该技术未涉及解析接口文档并生成接口文档最终数据。

公开号为“CN110806863A”的中国专利文献公开了名称为“一种接口文档生成方法及装置、电子设备、存储介质”的技术，该技术基于Swagger、程序代码的技术生成接口文档，其依赖程序代码，通用性差。

发明内容

本发明的目的是提供一种基于JSON解析的开放平台接口文档自动生成方法及系统，解决的技术问题：未有一种通用的接口文档自动生成技术。

为解决上述技术问题，本发明采用下述技术方案：一种基于JSON解析的开放平台接口文档自动生成方法，包括以下步骤：

步骤A：JSON源数据系统生成接口文档JSON数据；

步骤B：JSON解析引擎解析所述接口文档JSON数据并生成接口文档最终数据；

步骤C：接口文档管理系统校验所述接口文档最终数据的完整性和合法性，若校验通过执行步骤D；

步骤D：所述接口文档管理系统存储通过校验的所述接口文档最终数据。

优选地，在所述步骤A中，所述接口文档JSON数据包括接口名称、接口分类、接口基本路径、接口请求方法、接口请求参数、返回数据、tag及状态；所述接口请求方法包括GET与POST；所述状态包括已完成和未完成。

优选地，当所述接口请求方法为GET时，所述接口请求参数为Query参数；当所述接口请求方法为POST时，所述接口请求参数为Body参数。

优选地，所述JSON源数据系统通过API方式传送所述接口文档JSON数据至所述JSON解析引擎。

优选地，在所述步骤B中，所述JSON解析引擎校验所述接口文档JSON数据是否规范、完整，当所述接口文档JSON数据通过校验后，所述JSON解析引擎根据请求头参数、请求参数及响应参数分别解析所述接口文档JSON数据各个字段。

优选地，所述接口文档JSON数据被所述JSON解析引擎解析后得到的参数属性包括类型、是否必填、描述及示例值。

优选地，在所述步骤D中，所述接口文档管理系统通过前端H5页面形式展示所述接口文档最终数据。

本发明还提供一种基于JSON解析的开放平台接口文档自动生成系统，包括：

JSON源数据系统，用于提供符合规范的接口文档JSON数据；

JSON解析引擎，用于解析所述接口文档JSON数据，并生成接口文档最终数据；