光谱线插件

欢迎光临 光谱 线性插件 !

此插件允许您将 API 与 rules 集连接 .

设置

1. 安装此插件 :

# From your Backstage root directory
yarn --cwd packages/app add @dweber019/backstage-plugin-api-docs-spectral-linter

实体页

1. 添加插件作为标签到您的实体页面 :

// In packages/app/src/components/catalog/EntityPage.tsx
import { EntityApiDocsSpectralLinterContent, isApiDocsSpectralLinterAvailable } from '@dweber019/backstage-plugin-api-docs-spectral-linter';

...

const apiPage = (
  <EntityLayout>
    {/* other tabs... */}
    <EntityLayout.Route if={isApiDocsSpectralLinterAvailable} path="/linter" title="Linter">
      <EntityApiDocsSpectralLinterContent />
    </EntityLayout.Route>
  </EntityLayout>

2. 添加 backstage.io/spectral-ruleset-url 对你的注释 catalog-info.yaml数字 :

metadata:
  annotations:
    backstage.io/spectral-ruleset-url: <url-to-your-yaml-or-json-file>

默认规则集

您可以提供默认规则集 app-config.yaml 像这样

spectralLinter:
  openApiRulesetUrl: <url-to-your-yaml-or-json-file>
  asyncApiRulesetUrl: <url-to-your-yaml-or-json-file>

地方发展

有本地设置 plugins/api-docs-spectral-linter/dev 可以从 yarn --cwd plugins/api-docs-spectral-linter start 从根起.