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

原创 2015年07月08日 16:19:40

悲伤的历史


在进行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后端开发系列文章目录

版权声明:本文为博主原创文章,未经博主允许不得转载。

相关文章推荐

app后端开发系列文章目录

每一个程序员心中,都有一个大牛梦。我们在晨曦之光中敲击着代码,在寒冬覆雪中思考着0与1。夏练三伏 冬练三九这说的就是我们这群【江湖】中人。在这里我们门派林立,C语言派历史悠久,在江湖中就是嵩山少林,他...

API开发第一篇:关于session的APP服务端API开发

在开发APP的服务端的时候,在短信验证模块使用了session功能,但是在PC上显得简单的session在这里出现了问题,因为PHP的每次session会话是当脚本执行结束时,会在服务器中的临时文件夹...

API开发第四篇:定义客户端/服务端接口协议

在进行API开发的时候,需要事先定义好app与server交互的数据格式,这样前端人员与服务端人员才能够事先决定好如何获取数据、如何解析数据、如何传输协议。

php开发App接口

APP接口简介: 什么是app接口?app接口就是用服务端程序如php写好的脚本,以供app客户端请求而获得数据的一个东西。比如一个视频app的首页,肯定有一些视频列表,那么当你打开这个app时,这...

.NET Framework 3.5

.NET Framework 3.5 = .NET Framework 3.0 + .NET Framework 3.0 SP1 .NET Framework 3.0 = .NET Framework...

API开发第二篇:PHP的设计模式之工厂模式

设计模式是个好动西,今天先简单说说工厂模式的作用,后续会把这次API开发中使用的东西一点点写出来。算是一次总结吧。

app后端开发五:Xampp下配置https服务

网络环境的复杂、不安全性,在我们进行api开发过程中,大部分时候是需要使用https服务的。而且越来越多的服务,明显要求只有https协议的访问,他们才能够支持。

1.APP后端开发系列:登陆系统设计中的注意问题

github博客-首发地址 想写这个系列很久了,因为之前做这个东西花费了大量的精力,有必要分享出来与大家共享。以前也写了一些关于 APP后端开发的系列文章 由于当初功力不够,很多问题描述不清楚或者解决...

API开发第三篇:PHP的设计模式之完美的单例模式

网上常见的PHP单例模式,都不能复用,也就是说,如果A是单例,我的类B继承A后,要想B也是单例,需要重新写代码,很麻烦。如何让B继承后,也变成单例模式呢?那就进来看看我的分解吧!

PHP服务器端API原理及示例(接口开发)

相信大家都做过PHP请求API接口获取数据,比如淘宝API,微信公众平台,天气查询,快递查询等,有的需要参照接口文档根据签名算法构造sign(签名),或者设置token,然后通过curl发送POST请...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:深度学习:神经网络中的前向传播和反向传播算法推导
举报原因:
原因补充:

(最多只允许输入30个字)