如何使用 doxygen 创建 public 网络服务器 api 文档？
How to create a public webserver api documentation with doxygen?
我想用 php 构建一个 webserver api，并想用 doxygen 为 api endpoints 生成一个 public 文档。
到目前为止，我知道如何让 doxygen 用于我的内部代码文档，但我想创建第二个 public 文档，它仅描述 public 网络服务器端点。
我想将相应的文档放入我的控制器和操作中，以便在开发时可以同时更新任何端点更改，而不必同时维护代码和文档。
所以在一般情况下，我需要一种方法来标记我的 public 文档，并使 doxygen 白名单只用于我的 public 文档。
是否有实现此目标的标准或最佳实践方法？
什么是必要的配置步骤？
是否有任何基于 doxygen 的工具可以提供帮助？
谢谢
一些起点：
- 您需要第二个 doxygen 配置文件 (Doxyfile)，其中包含针对这两种情况的相关设置
- 您可能还需要使用
\if、\ifnot、\else、\endif、\cond 和 \endcond 等命令执行某些操作作为 ENABLED_SECTIONS，请参阅文档。
- 取决于函数的名称等。可能会使用
EXCLUDE_SYMBOLS
- 根据所有设置的方式，可能会减少外部文件集。
我终于自己找到了解决方案。正确的做法是使用 "OpenAPI"-tools，这些工具通常与所有常见编程语言中的 swagger 语法兼容。 （一些框架甚至提供内置支持，例如 LoopBack）
OpenAPI 规范旨在为外部创建文档，仅描述 public interfaces/API-endpoints
我想用 php 构建一个 webserver api，并想用 doxygen 为 api endpoints 生成一个 public 文档。
到目前为止，我知道如何让 doxygen 用于我的内部代码文档，但我想创建第二个 public 文档，它仅描述 public 网络服务器端点。
我想将相应的文档放入我的控制器和操作中，以便在开发时可以同时更新任何端点更改，而不必同时维护代码和文档。 所以在一般情况下，我需要一种方法来标记我的 public 文档，并使 doxygen 白名单只用于我的 public 文档。
是否有实现此目标的标准或最佳实践方法？ 什么是必要的配置步骤？ 是否有任何基于 doxygen 的工具可以提供帮助？
谢谢
一些起点：
- 您需要第二个 doxygen 配置文件 (Doxyfile)，其中包含针对这两种情况的相关设置
- 您可能还需要使用
\if、\ifnot、\else、\endif、\cond和\endcond等命令执行某些操作作为ENABLED_SECTIONS，请参阅文档。 - 取决于函数的名称等。可能会使用
EXCLUDE_SYMBOLS - 根据所有设置的方式，可能会减少外部文件集。
我终于自己找到了解决方案。正确的做法是使用 "OpenAPI"-tools，这些工具通常与所有常见编程语言中的 swagger 语法兼容。 （一些框架甚至提供内置支持，例如 LoopBack） OpenAPI 规范旨在为外部创建文档，仅描述 public interfaces/API-endpoints