美文网首页
利用ApiPost一键、快速生成接口文档!女猿也过38节!

利用ApiPost一键、快速生成接口文档!女猿也过38节!

作者: 小码哥聊技术 | 来源:发表于2019-03-07 22:59 被阅读0次

    对于我们这些程序员和程序媛来讲,最头疼的莫过于写文档。

    我们可都是正个八经的理工校草和理工女神,研究github、逛逛csdn、写hello world是才我们的拿手菜,写文档是文科生的事情好不啦?(手动吐哇吐)

    今天,教大家一个妙招:利用ApiPost一键、快速生成接口文档!妈妈再也不用担心自己女孩纸们没有时间过38节啦!

    ApiPost简介:

    ApiPost是一个支持团队协作,并可直接生成文档的API调试、管理工具。它支持模拟POST、GET、PUT等常见请求,是后台接口开发者或前端、接口测试人员不可多得的工具 。

    官网:https://www.apipost.cn/

    利用ApiPost一键、快速生成接口文档:

    当然,你得先下载安装apipost谷歌拓展或者客户端(个人建议客户端)。

    接下来介绍具体步骤。

    1、我们先准备一段接口代码用来测试。如图:

    一个简单的测试接口

    这个代码仅仅用来demo没啥技术含量,就是接受POST过来的2个参数,然后返回一个json。

    2、接下来,具体操作如下图(全程图片-一看就懂):

    发送结果

    参数描述填写

    3、利用全局注释功能,快速创建常见字段的描述

    添加全局注释

    添加全局注释

    添加全局注释

    4、点击顶部的文档模式就可以查看文档了。也可以导出为离线文档。

    查看接口文档

    导出接口文档

    嗯,好了。女神们,接口文档也生成了,赶紧丢给前端过节去吧!……(^ _ ^)

    相关文章

      网友评论

          本文标题:利用ApiPost一键、快速生成接口文档!女猿也过38节!

          本文链接:https://www.haomeiwen.com/subject/samkpqtx.html