一种网页生成方法技术

本申请涉及数据处理技术领域，涉及一种网页生成方法

【技术实现步骤摘要】
一种网页生成方法、装置、设备及可读存储介质


[0001]本申请涉及数据处理
，尤其涉及一种网页生成方法
、
装置
、
设备及可读存储介质
。

技术介绍

[0002]软件开发商需要将软件接口文档通过网站提供给用户
。
现有技术中，一般采用
Facebook
开源的
Docusaurus
文档框架实现站点，
Docusaurus
是一个非常成熟且出名的静态网站生成
(SSG)
框架，它支持将
markdown
，
MDX
写法的文件生成静态网页
(HTML)
，但
Docusaurus
框架并不支持将
OpenAPI
写法的
yaml
文件生成静态网页
。
[0003]OpenAPI
规范是一个标准的可解析的接口文档描述写法，因此网上也存在一些支持
OpenAPI
的
Docusaurus
插件，
Docusaurus
社区也推荐了两款插件：
[0004]一款是
redocusaurus
，它能很好的生成漂亮的
OpenAPI
网站，但是因为其是
redocly
的社区开源版本，因此功能有限无法满足复杂场景下的文档生成
。
比如，仅支持单个
OpenAPI
文件作为入口，无法运用于多个
OpenAPI
文件的场景
。
[0005]另一款是
docusaurus
‑
openapi
‑
docs
，它能够将
OpenAPI
转换成
markdown
文件，以提供给
Docusaurus
再次转换成静态网页，以展示到网站中
。
但这个插件更像是一个转换工具，需要手动运行命令对
yaml
文件进行
OpenAPI
的转换，
Docusaurus
才能够识别到新增或者更新，在存在大量文件的情况下，非常的难维护
。
[0006]在面对大量
OpenAPI
文件时，
redocusaurus
仅支持单个
OpenAPI
文件作为入口，生成效率低；而需要手动运行命令对
yaml
文件进行
OpenAPI
的转换，且不易维护，实现起来比较繁琐
。
总之，上述两款插件不适用将大量
OpenAPI
文件生成接口文件
。

技术实现思路

[0007]有鉴于此，本申请实施例提供一种网页生成方法
、
装置
、
设备及可读存储介质，可以有效解决现有接口展示网页生成方法在面对大量
OpenAPI
文件时，存在生成接口展示网页效率低
、
不易维护的问题等
。
[0008]第一方面，本申请实施例提供一种网页生成方法，所述方法包括：
[0009]接收文件监听模块监听预设路径下的各第一格式文件变动情况得到的对应的各变动信息；所述变动信息包括文件变动类型和对应的变动文件路径；
[0010]根据各所述文件变动类型确定对相应的所述第一格式文件的处理方式；所述处理方式包括转换格式；
[0011]若所述处理方式为转换格式，则将对应的所述变动文件路径设置到环境变量中，以将所述变动文件路径传递至文件格式转换模块；所述环境变量为设定的所述文件格式转换模块的入口路径；
[0012]驱动所述文件格式转换模块将所述变动文件路径对应的第一格式文件转换为第二格式文件；
[0013]驱动网站生成框架根据所述第二格式文件生成接口展示网页；所述网站生成框架为静态网站创建工具
。
[0014]在一些实施例中，所述文件监听模块采用
chokidar
插件；
[0015]所述接收文件监听模块监听预设路径下的各第一格式文件变动情况得到的对应的各变动信息，之前还包括：
[0016]设置所述
chokidar
插件的监听路径为所述第一格式文件的根路径
。
[0017]在一些实施例中，所述文件格式转换模块采用
docusaurus
‑
openapi
‑
docs
插件，所述网站生成框架采用
Docusaurus
文档框架；
[0018]通过配置插件的方式将所述
docusaurus
‑
openapi
‑
docs
插件集成于所述
Docusaurus
文档框架内，并将所述环境变量设置为所述
docusaurus
‑
openapi
‑
docs
插件的入口路径
。
[0019]在一些实施例中，所述
docusaurus
‑
openapi
‑
docs
插件通过配置插件的方式集成于所述
Docusaurus
文档框架后，在脚本命令配置文件中添加执行所述
docusaurus
‑
openapi
‑
docs
插件的快捷运行指令；所述第一格式文件为
OpenAPI
文件；所述第二格式文件为
markdown
文件；
[0020]所述将对应的所述变动文件路径设置到环境变量中，以将所述变动文件路径传递至文件格式转换模块，包括：
[0021]将接收的各个所述变动文件路径逐一设置到环境变量中，以逐个将所述变动文件路径传递至所述
docusaurus
‑
openapi
‑
docs
插件；
[0022]所述驱动所述文件格式转换模块将所述变动文件路径对应的第一格式文件转换为第二格式文件，包括：
[0023]通过执行所述快捷运行指令驱动所述
docusaurus
‑
openapi
‑
docs
插件将所述变动文件路径对应的
OpenAPI
文件转换为
markdown
文件
。
[0024]在一些实施例中，所述文件变动类型包括移动
、
新增
、
删除和更新中至少一项；所述处理方式还包括删除文件；
[0025]所述根据各所述文件变动类型确定对所述变动文件的处理方式，包括：
[002本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.
一种网页生成方法，其特征在于，包括：接收文件监听模块监听预设路径下的各第一格式文件变动情况得到的对应的各变动信息；所述变动信息包括文件变动类型和对应的变动文件路径；根据各所述文件变动类型确定对相应的所述第一格式文件的处理方式；所述处理方式包括转换格式；若所述处理方式为转换格式，则将对应的所述变动文件路径设置到环境变量中，以将所述变动文件路径传递至文件格式转换模块；所述环境变量为设定的所述文件格式转换模块的入口路径；驱动所述文件格式转换模块将所述变动文件路径对应的第一格式文件转换为第二格式文件；驱动网站生成框架根据所述第二格式文件生成接口展示网页；所述网站生成框架为静态网站创建工具
。2.
根据权利要求1所述的网页生成方法，其特征在于，所述文件监听模块采用
chokidar
插件；所述接收文件监听模块监听预设路径下的各第一格式文件变动情况得到的对应的各变动信息，之前还包括：设置所述
chokidar
插件的监听路径为所述第一格式文件的根路径
。3.
根据权利要求1所述的网页生成方法，其特征在于，所述文件格式转换模块采用
docusaurus
‑
openapi
‑
docs
插件，所述网站生成框架采用
Docusaurus
文档框架；通过配置插件的方式将所述
docusaurus
‑
openapi
‑
docs
插件集成于所述
Docusaurus
文档框架内，并将所述环境变量设置为所述
docusaurus
‑
openapi
‑
docs
插件的入口路径
。4.
根据权利要求3所述的网页生成方法，其特征在于，所述
docusaurus
‑
openapi
‑
docs
插件通过配置插件的方式集成于所述
Docusaurus
文档框架后，在脚本命令配置文件中添加执行所述
docusaurus
‑
openapi
‑
docs
插件的快捷运行指令；所述第一格式文件为
OpenAPI
文件；所述第二格式文件为
markdown
文件；所述将对应的所述变动文件路径设置到环境变量中，以将所述变动文件路径传递至文件格式转换模块，包括：将接收的各个所述变动文件路径逐一设置到环境变量中，以逐个将所述变动文件路径传递至所述
docusaurus
‑
openapi
‑
docs
插件；所述驱动所述文件格式转换模块将所述变动文件路径对应的第一格式文件转换为第二格式文件，包括：通过执行所述快捷运行指令驱动所述
docusaurus
‑
...

【专利技术属性】
技术研发人员：叶梓军，林煌东，王颖奇，冯斌，
申请(专利权)人：深圳复临科技有限公司，
类型：发明
国别省市：