doubi1818
2015-02-05 09:59
浏览 43
已采纳

在Codeigniter项目中生成REST文档

I have a REST webservice using Codeigniter and using this lib : https://github.com/chriskacerguis/codeigniter-restserver

I want to generate documentation for this web service. I look to use Swagger UI to generate this documentation. But, I didn't find any documentation how to use Swagger with Codeigniter.

The only project using this two technologies is this one, but don't have a good documentation : https://github.com/panxp/codeigniter-swagger

Can someone paste an example using this two technologies or give me a link to a good documentation ? Of course, if there is another good lib to generate documentation, I'll take it if it's usable with Codeigniter.

图片转代码服务由CSDN问答提供 功能建议

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

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

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

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

  • 写回答
  • 好问题 提建议
  • 关注问题
  • 收藏
  • 邀请回答

1条回答 默认 最新

  • doubo7131 2016-04-28 19:40
    已采纳

    In past projects I have used http://apidocjs.com/ which I find pretty easy to use and straightforward to generate from in multiple environments. It took me like 15-20 minutes to get going and looking how I wanted with it having npm already installed. This one doesn't really care about directory or code structure, just your supplied info in the doc blocks.

    已采纳该答案
    评论
    解决 无用
    打赏 举报

相关推荐 更多相似问题