由于博客搬家,我的博客将在: 懒惰的夜猫子 上发布
点击下方链接即查看:
----------------------------------------------------------------------------------------------------------------
第二行给个自我介绍:
我是一个很懒很懒的PHP程序猿,又经常写API,然而写API又需要提供API文档,写就算了,更改了API还需要更新文档,这让我受不了,我就检索一些自动生成API文档的工具,询问一些大牛,然而未果。所以有了这个工具。
为了和我一样懒的伸手党,我把这个工具给放github开源了 (APIDG )。觉得好用的话就赏我个Star吧。
那么我们开始介绍我这个工具了:
注:这个工具只支持处理 返回 JSON 的接口使用,这个工具除了保存文档部分全部由前端代码实现(对了,我是PHP程序猿),方便你们安装使用,并且运用了很多递归和 JsonArray 的处理,如果对算法感兴趣也是可以看看的,建议放在本地服务器使用,如果需要放在公网服务器还是自行斟酌一下代码的性能啊安全性什么的,出了什么事本宝宝概不负责哟。
如果在使用上有什么觉得不完善,不方便或是代码不够优化的地方,可以留言或私信我告知我,让我得到一些大牛的经验也好呀,我会挑选比较大众化的需求为大家更新的哟。
如果有对于这个工具的疑问,可以留言或者私信给我,让我增加经验
本工具只有一个save.php文件是后台的,这个文件只在保存文件的时候使用,如果需要移植其他平台的话,可以自己更改成适用的语言。如果不知道其他语言怎么写,可以留言我,我会给你讲解其他语言该怎么写。
那么我们开始吧!
首先我们要配置PHP(save.php)文件中的token,这个token作为一个用来操作文档的key使用。这是一个非常非常简易的过滤。
设置好了这个token就可以提供给需要操作文档的人了,查看文档是不需要token的。
当你操作文档的时候会使用到:
当你确定后会返回一些信息:
进入主页,也就是index.html
+代表添加,其他图标不讲解了,不然我都会鄙视我自己的。
添加目录页面是这样子的:
填好后,点击提交就添加了,回到主页可以选择API文档的目录。点击目录即可查看文档内容。
点击文档标题旁边的+可以往该目录文档下添加更多的API文档。
我这个工具现在支持的请求方式有:GET POST JSONP(JSONP是通过GET方式的)。
这里所有的参数都直接放在URL中,工具会自动处理你的参数。
当把这些信息弄好以后点击提交,就会显示出你的接口信息了。你只需要往每个字段后面添加说明就好了。
点击在下面的提交就可以,保存到该目录文档中。注:如果URL地址相同,会认为是修改文档,使用覆盖功能。
End------------------------------------------------------------------------------------------------------------
使用上就是这么的简单!
如果觉得该工具很好用的朋友,请告诉你的朋友们这个工具非常好用,顺便帮我点个Star哟。
谢谢亲!!!
工具下载地址:APIDG