confluence地址 (opens new window)

这里以“order”模块为例:

1、找到项目中modifyJsonFile.js文件,将key修改为order

2、在项目目录中打开控制台,运行node modifyJsonFile.js,看到控制台输出 ‘JSON 文件已成功修改!’,刷新页面,文件调整成功 tip:

原始 Swagger 文件保存在项目根目录的 swagger-source/JSON,不会被 VuePress 发布。docs/.vuepress/public/JSON 中的文件只包含 OpenAPI 接口及其依赖模型。

修改文档数据后可运行 npm run docs:check-security,确认公开 JSON 不包含非 OpenAPI 接口、未引用模型或后端 host 信息。

目前因为文档地址不全,其他模块请先通知开发者,或在urlMap中添加对应的地址,其中key:文件名,value: swagger-doce地址

目前通过apiUpdateList控制需要更新的api,如有添加,请在apiUpdateList列表中加入api名称

新增的api不需要处理会自动加入

删除 API 需要手动从 swagger-source/JSON 中移除对应接口后,再运行 npm run docs:sanitize

img.png