如何解决使用 apictl 在 WSO2 3.2.0 上添加 API 文档
有没有办法使用 apictl 工具添加/上传 API 文档?在 apictl init
之后,我尝试将文档文件复制到 Docs -> FileContents 目录,在导入项目 apictl import-api
后,文档在开发人员/发布商门户上不可见。
除了UI 和Rest 调用,还有其他发布API 文档的方式吗?谢谢。
解决方法
是的,您可以使用 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 兼容的文档 here 创建的完整 API 工件。
提示:-如果您想更加确定,请像往常一样使用 UI 创建带有文档的 API。使用 apictl export-api
命令导出特定 API。然后,检查导出的 API 存档的 Docs 目录以获取想法。
更新(2021 年 5 月 2 日):请参阅链接 here,了解如何使用 WSO2 API 控制器作为分步指南来管理您的 API 文档。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。