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

有没有办法使用apictl工具添加/上传API文档？在

apitl init

之后，我尝试将文档文件复制到Docs->FileContents目录，并且在导入项目

apitl import api

之后，文档在开发人员/发布者门户上不可见

---

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

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

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

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

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。使用

apitl导出API

命令导出特定API。然后，检查导出的API归档文件的文档目录以了解情况

---

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

于2021年5月2日编辑了此内容，添加了一个链接，了解如何使用WSO2 API控制器管理您的文档（）