接口文档那点事儿二

        上次写出来个文本版的接口文档,后来又用postman挨个测了一遍才提交上去,可能是因为文本不方便开发的原因,大佬说让我把这些接口信息都转移到一个团队开发应用上去,所以才有了这一篇文章.

        我们用的应用是apifox,国内的,免费,有兴趣的找官网下一个就行.

        先说说用户界面哈

        用着还是蛮舒服的,简单易懂,有些内容我就把之前文档里记录的东西搬上去就行.,例如:

         

        接下来主要讲讲测试的内容,apifox和postman的测试方法是基本相同的

各个空要怎么填图里有写 

        要细讲的内容不多,就是把上一篇完成的内容搬上来而已.

        然后是写返回响应

        去apifox的运行窗口,输入接口需要的数据->发送,就能看到返回的数据了

        然后复制返回的数据,可以用文档的"JSON导入"导入返回响应的数据 ,示例也是

返回响应的"JSON导入" 

 

"JSON导入" 页面 

返回响应的成功示例(有失败示例最好也写上) 

 

        写文档不难,但是为了方便前后端对接,这很必要.在后面的对接讨论也因为这个文档的存在更加顺利.