Schema文档生成方法、装置、计算机设备和介质制造方法及图纸

本公开提供了一种Schema文档生成方法、装置、计算机设备和介质，其中，该方法包括：拉取接口描述语言IDL文件，所述IDL文件中包含有Schema参数和附加信息；根据所述IDL文件生成Schema描述信息，所述Schema描述信息包括所述Schema参数和所述附加信息；或者获取Schema描述信息，所述Schema描述信息为根据IDL文件生成的，所述IDL文件中包含有Schema参数和附加信息；根据所述Schema描述信息生成Schema文档。基于IDL文件生成的Schema文档格式统一，提高了Schema文档编写和维护的效率。

【技术实现步骤摘要】
Schema文档生成方法、装置、计算机设备和介质
本公开涉及计算机
，具体而言，涉及一种Schema文档生成方法、装置、计算机设备和介质。
技术介绍
应用程序(Application，APP)是指为了完成某项或某几项特定任务而被开发运行于操作系统之上的计算机程序。各类APP在使用时都有各自的APP页面，每一个APP页面都对应一个地址链接，每个APP页面的地址链接称为APP页面的Schema。APP主框架与APP页面之间的交互，一个APP页面与另一个APP页面之间的交互都通过Schema完成。对于一个大型的APP，不同的APP页面一般由不同的团队和开发人员开发，不同的开发人员通过Schema进行协作，另外，测试人员也需要通过Schema进行测试。为了使相关开发人员和测试人员紧密合作，需要维护一份Schema文档。一般情况下，Schema文档使用在线文档编译器手动进行编写和维护。手动编写和维护文档一方面操作繁琐，另一方面，由于不同编写人员编写的Schema文档格式不同，因此，使用手动的方式编写和维护的schema文档格式混乱，本文档来自技高网...

【技术保护点】
1.一种Schema文档生成方法，其特征在于，包括：/n拉取接口描述语言IDL文件，所述IDL文件中包含有Schema描述信息，所述Schema描述信息包括Schema参数和附加信息；/n根据所述IDL文件生成Schema描述信息。/n

【技术特征摘要】
1.一种Schema文档生成方法，其特征在于，包括：
拉取接口描述语言IDL文件，所述IDL文件中包含有Schema描述信息，所述Schema描述信息包括Schema参数和附加信息；
根据所述IDL文件生成Schema描述信息。


2.根据权利要求1所述的方法，其特征在于，在所述IDL文件的数据集类型中描述所述Schema参数；在所述IDL文件的注释中描述所述附加信息。


3.根据权利要求2所述的方法，其特征在于，根据所述IDL文件生成Schema描述信息，包括：
利用解析器解析所述IDL文件得到抽象语法树AST；
遍历所述AST得到所述Schema参数；
利用正则表达式解析所述IDL文件的注释得到所述附加信息。


4.根据权利要求2所述的方法，其特征在于，所述IDL文件包括Thrift文件和Protobuf文件，在所述Thrift文件中使用结构体struct类型描述所述Schema参数；在所述Protobuf文件中使用信息message描述所述Schema参数。


5.根据权利要求1-4任一权利要求所述的方法，其特征在于，所述Schema描述信息为json格式的。


6.一种Schema文档生成方法，其特征在于，包括：
获取Schema描述信息，所述Schema描述信息为根据IDL文件生成的，所述Schema描述信息包括Schema参数和附加信息；
根据所述Schema描述信息生成Schema文档。


7.根据权利要求6所述的方法，其特征在于，所述Schema描述信息为json格式的；以及
根据所述Schema描述信息生成Schema文档，具体包括：
根据json格式的Schema描述信息，生成超文本标记语言HTML格式的Schema文档。


8.一种Schema文档生成装置，其特征在于，包括：
拉取模块，用于拉取接口描述语言IDL文件，所述IDL文件中包含有Schema描述信息，所述Schema描述信息包括Schema参数和附加信息；
生成模块，用于根据所述IDL文件生成Schema描述信息。

【专利技术属性】
技术研发人员：邬亮，
申请(专利权)人：北京字节跳动网络技术有限公司，
类型：发明
国别省市：北京;11