在 Codeigniter 项目中生成 REST 文档

Question

我有一个使用Codeigniter框架构建的REST Web服务，并使用这个库：https://github.com/chriskacerguis/codeigniter-restserver。

我想为这个Web服务生成文档。我想使用Swagger UI生成这个文档，但是我没有找到如何在Codeigniter中使用Swagger的文档。

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

是否有人可以提供使用这两种技术的示例或给我一个链接到好的文档？ 当然，如果有另一个好的库可用于生成文档，并且能够与Codeigniter一起使用，我也会考虑采用。

- Xavier W.

Answer 1

在以前的项目中，我使用过http://apidocjs.com/，我发现它非常易于使用，并且可以在多个环境下直接生成。它只需要花费我15-20分钟就可以方便地完成自己的设置，并且已经安装了npm。这个工具不太关心目录或代码结构，只关注文档块中提供的信息。

- caseyh

Answer 2

你可以使用https://github.com/manish29ify/codeigniter3-restapi-with-swagger。尽管它还在开发中，但是你可以非常容易地将Swagger与PHP rest server一起使用。

- Vibhor Sharma

---

“链接式答案”被认为是非常低质量的，可能会被删除，请将链接资源中重要部分放入答案正文中。 - helvete