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

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

restful api文档生成器--神器

我现在还不是很懂到底什么才是restful api,目前理解的大概就是:一种接口,只管拿参数进来,做一系列处理,返回json字符串形式的结果。而restful api风格的api文档,就是用来说明这个...

apidoc接口文档自动生成工具

使用背景 : 由于后端接口开发好,提供接口文档供前端人员调用;由于某种原因,修改了接口,文档没有及时更新,导致后续交接或联调时接口文档不匹配;使用apidoc文档自动生成工具,解决这一问题。 ...

告别手写 API文档生成工具推荐

随着API的发展以及需求的日益增加,对API文本文档的需求与随之而来。相信许多开发人员都遇到过编写API文档方面的问题及烦恼。 你是否还通过手写的方式来生成和编写这些文档呢?那么你就OUT啦!话说工...

swagger和springmvc结合自动生成api接口文档

swagger和springmvc结合自动生成api接口文档

IDEA生成API接口文档

IDEA生成API接口文档 第一步: 第二步: 第三步: 最后一步: 点击OK就over了! 完美over!!...

Spring-Boot + Swagger2 自动生成API接口文档

spring-boot作为当前最为流行的Java web开发脚手架,相信越来越多的开发者会使用其来构建企业级的RESTFul API接口。这些接口不但会服务于传统的web端(b/s),也会服务于移动端...

webAPI 自动生成帮助文档

之前在项目中有用到webapi对外提供接口,发现在项目中有根据webapi的方法和注释自动生成帮助文档,还可以测试webapi方法,功能很是强大,现拿出来与大家分享一下。 先看一下生成的weba...

分享一款简单好用的接口文档管理工具

小幺鸡。 支持websocket测试 支持json,xml,txt,jsonp等测试 支持form-data,x-www-form-urlencoded ,raw...
  • cn_bboy
  • cn_bboy
  • 2016年09月01日 11:06
  • 6877

API文档自动生成工具

这是一个可以自动生成API文档的工具。操作简便,懒人必备!后端程序员必备良品!...

一个给 Java 程序员用的 Api 文档生成工具

api 文档作为前后端同学的沟通桥梁,其重要性是不言而喻的。目前通用的工具有像apidoc/apidoc,caixw/apidoc 这样的第三方库,虽然具有语言无关的特性,但是真正用起来额外多了很多工...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:app后端开发二:API接口文档自动生成工具
举报原因:
原因补充:

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