时间戳

首页 > 解决方案 > 使用 apictl 在 WSO2 3.2.0 上添加 API 文档

wso2 - 使用 apictl 在 WSO2 3.2.0 上添加 API 文档

问题描述

有没有办法使用 apictl 工具添加/上传API 文档？之后apictl init，我尝试将文档文件复制到 Docs -> FileContents 目录，并且在导入项目后apictl import-api，文档在开发人员/发布者门户上不可见。

除了UI和Rest调用，还有其他发布 API 文档的方式吗？谢谢。

标签： wso2wso2-am

解决方案

是的，您可以使用 apictl 上传文档。

如果您想上传 .pdf 或任何文件作为文档，您需要将其添加到FileContents文件夹中。但如果要添加内联文档或降价内容，则需要到InlineContents文件夹。

另一个重要的事情是，您需要在Docs目录中包含包含文档详细信息的docs.yaml文件。例如，Docs目录结构应如下所示。

Docs
├── docs.yaml
├── FileContents
│   └── test file document.pdf
└── InlineContents
    └── Doc1

有关更多信息，请参阅下面的示例docs.yaml文件。

-
  type: HOWTO
  name: Doc1
  summary: test
  sourceType: INLINE
  visibility: API_LEVEL
 -
  type: HOWTO
  name: Doc2
  summary: file test
  sourceType: FILE
  visibility: API_LEVEL
  filePath: test file document.pdf

在docs.yaml文件中，您需要将文档的详细信息指定为数组，如上所示。以上是我为导入 2 个文档而创建的示例。第一个文档是内联文档，第二个是文件。

您可以参考我在此处使用文档创建的与 APICTL 3.2.1 和 APIM 3.2.0 兼容的完整 API 工件。

提示：-如果您想更确定，请像往常一样使用 UI 创建一个包含文档的 API。apictl export-api使用命令导出特定 API 。然后，检查导出的 API 存档的Docs目录以了解一下。

更新（2021 年 5 月 2 日）：请参阅此处的链接，了解如何使用 WSO2 API 控制器作为分步指南来管理您的 API 文档。

推荐阅读