在Codeigniter项目中生成REST文档

Question

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

我想为这个Web服务生成文档.我希望使用Swagger UI来生成此文档.但是,我没有找到任何文档如何使用Swagger与Codeigniter.

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

有人可以使用这两种技术粘贴一个例子,或者给我一个良好文档的链接？当然,如果有另一个好的lib来生成文档,如果它可以与Codeigniter一起使用,我会接受它.

Answer 1

在过去的项目中，我使用了http://apidocjs.com/，我发现它很容易使用，并且可以在多种环境中直接生成。我花了大约15至20分钟的时间才能查看并希望安装npm。这实际上并不关心目录或代码结构，仅关心您在doc块中提供的信息。