Confluence 中 API 文档的建议？

Question

我们已经使用 Confluence 来记录软件产品。

有人对 API 文档的最佳方法有任何建议吗？

例如用户 Confluence 与 Swagger 插件在页面上显示 API 文档？

Answer 1

您可以尝试一些已经存在的第三方插件，例如：

1. https://marketplace.atlassian.com/apps/1219386/open-api-swagger-integration?hosting=cloud&tab=overview
2. https://marketplace.atlassian.com/apps/1220747/swagger-ui-for-confluence?hosting=cloud&tab=overview 您可以在其页面上查看每个插件的文档，但要点是设置您拥有的 Swager（开放 API）文件位置，它将在 Confluence 中生成。

另一种方法是使用页面编辑器以及创建动态文档并将其导出到 Word 或根据需要重复使用所需的所有宏，自行在 Confluence 页面上编写文档。