菜鸟coder怎么办?

志存高远,不忘初心

app后端开发二:API接口文档自动生成工具

悲伤的历史


在进行app后端开发过程中,后端会提供出来很多的api接口供前端开发使用,为了让前端开发人员顺利使用,我们会写好一份文档,告诉他们这个接口你该用 GET 还是 POST 来访问,同时访问的时候该给我传递一些什么参数,以及正确的时候我会返回什么给你,已经返回的数据样式以及字段解释等等这些事情,我们都需要在文档中写好写清楚。

app后端开发一:基于swagger-ui构建api接口文档工具 这篇博客中,我写了 swagger-ui 的好处以及优势。但是在使用过程中,发现不够给力。我想要达到的是代码写完,注释写完API接口文档就出来了。不用再费时费力的单独去维护它。因此今天决定告诉大家如果利用Laravel5来自动生成API接口文档。

PS:如果你对 Laravel5 还不够了解,可以点击这里 查看。

使用场景


这是我基于 Laravel5 开发的一个API文档自动生成插件。它前端利用的还是Swagger-UI(使用的还是我自己改造的中文版),后端使用的是Swagger-PHP。通过composer安装该插件后,只要你写的Model与Controller按照规定写好注释,你的API文档就会在访问的时候自动扫描这些注释,来实时生成API文档接口。

效果截图:
这里写图片描述
这个展现了每个模块提供的操作。

这里写图片描述
点击测试按钮后,可以直接进行操作,这里前端的介绍跟我写的第一篇文档是一直的。

这里主要增加的在于后端部分自动生成,前端没有什么变化。

获取这个插件


具体怎么安装继承到项目中,请看这里
项目地址: GitHub项目地址
备注:该项目只能用于Laravel5,并且只能使用composer进行安装。

如果大家觉得有帮助,或者能够提供帮助一起完善这个项目的,欢迎 StarPull requests

app后端开发系列文章目录

阅读更多
版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/hel12he/article/details/46804915
个人分类: PHP开发
想对作者说点什么? 我来说一句

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

加入CSDN,享受更精准的内容推荐,与500万程序员共同成长!
关闭
关闭