API文档自动生成工具

由于博客搬家，我的博客将在: 懒惰的夜猫子上发布

点击下方链接即查看：

API文档自动生成工具

----------------------------------------------------------------------------------------------------------------

第二行给个自我介绍：

我是一个很懒很懒的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

API文档自动生成工具相关推荐

Java api文档自动生成工具smartdoc+torna
首先,一般做java服务端都用过postman,并且都写过前端调用的api文档接口,并且也用过市面上的一些工具. API自文档动生成,能够省去了写文档的时间. 当然,当前也会有很多类似的开源工具,我们 ...
API文档自动生成的方法
编写API文档是API编写人员的噩梦,而API文档通常是由API研发人员编写.由于API文档创建繁琐,需要记录的内容比较广,结束了API开发任务后,还要仔细编写API文档,给研发人员带来额外的工作量. ...
java如何生成api文档_api文档自动生成工具
java开发,根据代码自动生成api接口文档工具,支持RESTful风格,今天我们来学一下api-doc的生成预览在线预览地址开发原理这个工具是一个典型的前后端分离开发的项目,想了解前后端分离 ...
使用swagger实现在线api文档自动生成在线测试api接口
使用vs nuget包管理工具搜索Swashbuckle 然后安装便可注释依赖于vs生成的xml注释文件转载于:https://www.cnblogs.com/ProDoctor/p/752607 ...
python docx 合并文档图片_MBT文档模型化生成工具——30倍效率文档撰写工程化方法...
MBT(A model based document builder)文档模型化生成工具用户手册--30倍效率文档撰写工程化方法 1 简介在软件工程领域,工程文档通常主要包括实施方案.需求分析.软件 ...
Word 2010文档自动生成目录和某页插入页码
一.Word 2010文档自动生成目录关于Word文档自动生成目录一直是我身边同学们最为难的地方,尤其是毕业论文,经常因为目录问题,被要求修改,而且每次修改完正文后,目录的内容和页码可能都会发生变化 ...
Java支持latex,基于Java和LaTeX的文档自动生成技术研究
基于Java和 LaTeX 的文档自动生成技术研究 ◆尚宝欣徐屹 (东北电力大学理学院,吉林长春 132012) [摘要]讨论了结合Java与LaTex 自动生成 PDF文档的方法.针展名 ...
Java实现生成数据库表结构文档（生成工具screw的使用）
目录一.screw介绍 1.简介 2.特点 3.文档格式二.生成方式 2.1 方式1:使用 Java 代码 2.1.1 引入依赖 2.1.2 编写代码 2.1.3 测试 2.2 方式2:使用 Sp ...
干掉 Postman？测试接口直接生成API文档，这工具真香！
前几天粉丝群有小伙伴问,有啥好用的API文档工具推荐,无意间发现了一款工具,这里马不停蹄的来给大家分享一下. ShowDoc一个非常适合团队的在线API文档工具,也支持用docker自建文档服务,不过 ...
干掉 Postman？测试接口直接生成API文档，这个工具我爱了
前几天粉丝群有小伙伴问,有啥好用的API文档工具推荐,无意间发现了一款工具,这里马不停蹄的来给大家分享一下. ShowDoc一个非常适合团队的在线API文档工具,也支持用docker自建文档服务,不过 ...

API文档自动生成工具

API文档自动生成工具相关推荐

最新文章

热门文章