codeigniter集成Swagger自动化生成RESTFUL文档

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/webchengxuyuan/article/details/48372129

        最近用CI写一个移动APP的服务器端RESTFUL接口。在开发过程中与前端开发人员沟通接口至关重要。原来我们一直使用WORD文档,上传到QQ群供前端开发下载。虽然工作进行没什么大问题,但是每次写完代码都的写WORD文档再传到QQ群的方式我还是感到很低效。

        因此我就研究了原来用beego(golang写的WEB框架)时看到的Swagger工具,看看能不能集成到CI中,GOOGLE了一下,发现了一个codeigniter-swagger的工具。工具使用很简单。把swagger包拷到根目录下就可以使用了。我分析swagger的原理是将代码里符合swagger规范的注释抽取出来翻译为文档。我按照范例写了注释,然后执行了php swagger.phar /home/wwwroot/ci/application/controller(注释目录) -o /home/wwwroot/ci/docs/json(在线文档目录)命令。在线文档就生成了,不过文档的代码注释会很多。采用这个工具不仅和前端沟通变得更简单,而且对养成后端开发人员良好的代码和注释规范也起到了很好的督促作用。

     codeigniter-swagger的GITHUB地址:https://github.com/panxp/codeigniter-swagger

     swagger的官方网址:http://swagger.io/

阅读更多

扫码向博主提问

快刀老码农

普及AI,让技术人认知、技能双升级
去开通我的Chat快问

没有更多推荐了,返回首页