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

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

我们可都是正个八经的理工校草和理工女神,研究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、点击顶部的文档模式就可以查看文档了。也可以导出为离线文档。

查看接口文档

导出接口文档

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

©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 16,591评论 4 61
  • 拖了很久的房屋租管售计划,内心还是惴惴不安没写完 执行力还是太差 昨天和JY吃饭了,差点 没把她带回家 删掉了一次...
    琛周阅读 367评论 0 0
  • 清平调三首 李白云想衣裳花想容,春风拂槛露华浓;若非群玉山头见,会向瑶台月下逢。 一枝红艳露凝香,云雨巫山枉断肠...
    明朗说阅读 1,107评论 0 3
  • 「自律挑战100天」Day35 2019.02.15 【早起】懒癌症犯了,直到6.50才起床。 【运动】健行102...
    芹菜叶阅读 525评论 2 15
  • 见到小雯的那天晚上,恰巧是我最狼狈的一夜。 我独自躺在一米八的双人大床上,眼泪如小蟹般爬满了整张脸。 两个小时前,...
    胡叶平阅读 460评论 0 1

友情链接更多精彩内容