php - 在 Codeigniter 项目中生成 REST 文档

Question

我有一个使用 Codeigniter 并使用此库的 REST 网络服务:https://github.com/chriskacerguis/codeigniter-restserver

我想为这个网络服务生成文档。我希望使用 Swagger UI 来生成此文档。但是，我没有找到任何关于如何将 Swagger 与 Codeigniter 结合使用的文档。

唯一使用这两种技术的项目是这个，但没有很好的文档:https://github.com/panxp/codeigniter-swagger

有人可以粘贴使用这两种技术的示例或给我一个好的文档的链接吗？当然，如果有另一个好的库来生成文档，如果它可以与 Codeigniter 一起使用，我会接受它。

Answer 1

在过去的项目中，我使用了 http://apidocjs.com/我发现它非常易于使用并且可以直接在多个环境中生成。我花了大约 15 到 20 分钟才开始，并在已经安装了 npm 的情况下查看我想要的方式。这个并不真正关心目录或代码结构，只关心您在文档 block 中提供的信息。