# @dweber019/backstage-plugin-api-docs-module-wsdl 中文文档

规范地址：https://npmcn.com/package/%40dweber019/backstage-plugin-api-docs-module-wsdl/

版本：0\.1\.2
npm 元数据更新时间：2025-12-19T07:45:20.874Z
中文译文更新时间：2026-11-13T03:53:46.769Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40dweber019/backstage-plugin-api-docs-module-wsdl
原文对照：https://npmcn.com/package/%40dweber019/backstage-plugin-api-docs-module-wsdl/?lang=original
项目主页：https://github.com/dweber019/backstage-plugins/tree/main/plugins/api-docs-module-wsdl
源码仓库：https://github.com/dweber019/backstage-plugins

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：18.1 kB，17 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：7 个
- peer 依赖：react ^16\.13\.1 \|\| ^17\.0\.0 \|\| ^18\.0\.0，react-dom ^16\.13\.1 \|\| ^17\.0\.0 \|\| ^18\.0\.0，react-router-dom 6\.0\.0-beta\.0 \|\| ^6\.3\.0
- 首次发布：2023-12-22T10:03:30.155Z
- 最新版本发布：2025-12-19T07:45:20.670Z
- 近 30 天下载量：2366（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：24（近 12 个月 1 个）

## 中文简介

让 WSDL 输出的 api- docs 插件的额外功能

## 安装

```sh
npm install @dweber019/backstage-plugin-api-docs-module-wsdl
```

也可以使用：`pnpm add @dweber019/backstage-plugin-api-docs-module-wsdl`、`yarn add @dweber019/backstage-plugin-api-docs-module-wsdl`、`bun add @dweber019/backstage-plugin-api-docs-module-wsdl`

## README

# @dweber019/后台-plugin-api-docs-module-wsdl

前端为 `@dweber019/backstage-plugin-api-docs-module-wsdl-backend` 后端插件 .  
您也需要安装后端插件 .

## 设置

```
yarn --cwd packages/app add @dweber019/backstage-plugin-api-docs-module-wsdl
```

### 将 wsdl DocsApiWidget 添加到您的 APis 中

将部件添加到您的 `apiDocsConfigRef`。 。 。 .

```ts
// packages/app/apis.ts

import {
  apiDocsModuleWsdlApiRef,
  ApiDocsModuleWsdlClient,
  wsdlApiWidget,
} from '@dweber019/backstage-plugin-api-docs-module-wsdl';

export const apis: AnyApiFactory[] = [
  createApiFactory({
    api: apiDocsModuleWsdlApiRef,
    deps: {
      identityApi: identityApiRef,
      discoveryApi: discoveryApiRef,
    },
    factory: ({ identityApi, discoveryApi }) =>
      new ApiDocsModuleWsdlClient({ identityApi, discoveryApi }),
  }),
  createApiFactory({
    api: apiDocsConfigRef,
    deps: {},
    factory: () => {
      const definitionWidgets = defaultDefinitionWidgets();
      return {
        getApiDefinitionWidget: (apiEntity: ApiEntity) => {
          if (apiEntity.spec.type.toLowerCase() === 'wsdl') {
            return wsdlApiWidget(apiEntity);
          }
          return definitionWidgets.find(d => d.type === apiEntity.spec.type);
        },
      };
    },
  }),
];
```

### 在您的 API 实体中设置类型

此部件将生成生成 `wsdl` 说明 `xslt` 转变.

```yaml
apiVersion: backstage.io/v1alpha1
kind: API
metadata:
  name: hello-world
  description: Hello World example for WSDL
spec:
  type: wsdl
  lifecycle: deprecated
  owner: foo
  definition:
    $text: http://www.dneonline.com/calculator.asmx?wsdl
```

您可以在 `./dev`。 。 。 .

## 地方发展

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

> 别忘了本地开发后端也.

## 常见问题

### @dweber019/backstage-plugin-api-docs-module-wsdl 是什么？

让 WSDL 输出的 api- docs 插件的额外功能

### 如何安装 @dweber019/backstage-plugin-api-docs-module-wsdl？

在项目目录运行 npm install @dweber019/backstage-plugin-api-docs-module-wsdl，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^16\.13\.1 \|\| ^17\.0\.0 \|\| ^18\.0\.0）、react-dom（^16\.13\.1 \|\| ^17\.0\.0 \|\| ^18\.0\.0）、react-router-dom（6\.0\.0-beta\.0 \|\| ^6\.3\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @dweber019/backstage-plugin-api-docs-module-wsdl 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @dweber019/backstage-plugin-api-docs-module-wsdl 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @dweber019/backstage-plugin-api-docs-module-wsdl 可以商用吗？

@dweber019/backstage-plugin-api-docs-module-wsdl 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @dweber019/backstage-plugin-api-docs-module-wsdl 的下载量有多少？

根据 npm 官方下载统计，@dweber019/backstage-plugin-api-docs-module-wsdl 在 2026/10/13 – 2026/11/11 这 30 天内被下载 2,366 次，日均约 79 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @dweber019/backstage-plugin-api-docs-module-wsdl 还在维护吗？

最新版本 0\.1\.2 发布于 2025/12/19（10 个月前）；至今共发布 24 个版本，其中过去 12 个月发布了 1 个；首次发布于 2023/12/22。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。