在Codeigniter项目中生成REST文档

时间:2015-02-05 09:59:37

标签: php web-services codeigniter rest swagger-php

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

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

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

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

1 个答案:

答案 0 :(得分:5)

在过去的项目中,我使用了http://apidocjs.com/,我发现它很容易使用,并且可以直接在多个环境中生成。我花了15-20分钟才开始,看着我已经安装了npm的想法。这个人并不真正关心目录或代码结构,只是你在doc块中提供的信息。