有没有办法使用 redocly 自定义 HTML 输出,使得版本号不显示?

问题描述 投票:0回答:1

Redocly 使用

redocly build-docs
生成文档,它摄取 OpenAPI yaml 并输出 html 文件。在生成的 html 文件中,文档中生成了一个版本字符串,该字符串源自
info.version

未能定义

info.version
意味着您将无法传递 OpenAPI lint。但是,删除版本号会生成所需的 html 输出。 Redocly 只是忽略版本并生成没有版本的 HTML。

问题是我们分配构建号的构建系统与我们的沙箱不同,沙箱还没有版本号。有没有办法在生成的文档中隐藏

info.version
的包含,以便版本号可以按照规范的要求存在于
.yaml
文件中,但不存在于生成的
.html
文件中。
redocly
是否支持主题以隐藏输出中的版本号?

themes openapi redocly
1个回答
0
投票

根据我的评论,有类似的内容

插件/装饰器/hide-info-version.js

module.exports = HideInfoVersion;

function HideInfoVersion() {
  console.log("removing Info.version");
  return {
    Info: {
      leave(target) {
        if(target.version) {
          delete target.version;
        }
      }
    },
  }
};

插件/index.js

const HideInfoVersion = require('./decorators/hide-info-version.js');

// this is our custom identifier
const id = 'myUniqueId';

module.exports = { id, decorators };

const decorators = {
  oas3: {
    'hideInfoVersion': HideInfoVersion
  };
};

redocly.yaml

plugins:
  - "./linting/plugins/index.js"

decorators:
  myUniqueId/hideInfoVersion: on
© www.soinside.com 2019 - 2024. All rights reserved.