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

Question

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

我想为此 Web 服务生成文档。我希望使用 Swagger UI 来生成此文档。但是，我没有找到任何文档如何将 Swagger 与 Codeigniter 一起使用。

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

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

Answer 1

在过去的项目中，我使用过http://apidocjs.com/，我发现它非常易于使用，并且可以直接在多个环境中生成。我花了大约 15 到 20 分钟的时间来看看已经安装了 npm 的我想要的效果。这个并不真正关心目录或代码结构，只关心您在 doc 块中提供的信息。

Answer 2

您可以使用https://github.com/manish29ify/codeigniter3-restapi-with-swagger它仍在开发中，但您可以非常轻松地将 Swagger 与 PHP REST 服务器一起使用