如何使用doxygen创建公共的Web服务器api文档？

Question

我想用webserver api构建一个php，并想使用api endpoints为doxygen生成一个公共文档。

到目前为止，我知道如何在内部代码文档中使用doxygen，但我想创建第二个公共文档，该文档仅描述公共Web服务器端点。

我想将相应的文档放入控制器和操作中，以便在开发时可以同时更新任何端点更改，而不必并行维护代码和文档。 因此，在Gerenal中，我需要一种方式以某种方式标记我的公开文档，并使doxygen仅将这些公开文档列入我的公开文档。

是否有实现此目标的标准或最佳实践方法？ 有哪些必要的配置步骤？ 是否有任何基于doxygen的工具可以帮助您？

谢谢

Answer 1

一些起点：

• 您需要第二个doxygen配置文件（Doxyfile），其中包含两种情况的相关设置
• 您可能需要使用\if，\ifnot \else，\endif，\cond和\endcond等命令以及ENABLED_SECTIONS，请参阅文档。
• 取决于函数的名称等，可能可以使用EXCLUDE_SYMBOLS
• 根据所有设置的方式，有可能减少外部文件集。

Answer 2

我终于找到了解决方案。正确的方法是使用“ OpenAPI”工具，这些工具通常与所有常见编程语言中的swagger语法兼容。 （某些框架甚至提供内置支持，例如LoopBack） OpenAPI规范旨在为外部人员创建文档，仅描述公共接口/ API端点