prepare-to-face-api

对接 API 的准备 – Postman

我司目前使用的是 swagger, 一般情况下是什么返回只有一个简单的sample, 但是有时候后台会变, 而且参数什么的直接在网页上不好复制, 这时候可以通过导出一个文件, 然后再导入到Postman里, 即可以测试 API 和数据, 又能通过 raw request 拿到纯文本的东西. 方便转成我们的 Model

一般来说, 开发的很多应用都是杜对接 API 的, 如果是像一些平台, 他们提供的 API 很完善, 也很方便的调用, 甚至不用调用就有文档可以说明怎么调用, 然后返回的是什么东西, 我们根据那个开发即可.

但是有时候, 公司内部开发的话, 文档不对外, 做的也部署很完善的, 都会提供 Swagger(一个后端接口文档工具, 一般使用 Spring 的话会直接有工具生成以供使用) 这也可以! 但是! 这些接口是没有什么更多的说明的! 除了多沟通也没有更好的办法了( ̄工 ̄lll)而且! 有时候生成的 Swagger 是在调用的时候链接的地址还是本地的!! 这就很操蛋了啊( ̄工 ̄lll)

我就问我们运维小哥, 有没有方便点的让我好调用点啊什么的( ̄工 ̄lll)

  1. 开 Terminal, 把那个 curl 的命令粘贴进去改域名( ̄工 ̄lll). (WTF?)
  2. Postman, 将链接粘贴进去, 自己填参数, 再修改域名.. 貌似好点了(WTF?)
  3. 自己本地起一个后端服务( ̄工 ̄lll)
  4. 他开一个服务( ̄工 ̄lll)我去打开那个 swagger( ̄工 ̄lll).(那你关掉了我也就宕机了( ̄工 ̄lll))

于是..在比较好的方法里, 利用 Postman 还能有什么更好的方法, 感觉使用 Postman 不止能做一点点的. 果然! 被我发现了! 可以导入! 导入说明里有 Swagger 的文档文件!

说是输入地址( ̄工 ̄lll) 嗯( ̄工 ̄lll)于是输入了 Swagger 的地址( ̄工 ̄lll).傻逼了, 说链接到的格式不对( ̄工 ̄lll)

查了下, 因为不是要输入网址啊! 是输入文档的链接! 这个我这边是在第一行标题下有个api-docs 结尾的链接, 就是那个! 填入链接, 大功告成~

但是( ̄工 ̄lll) 因为这个文档给的链接导出的还是和页面上一样的 localhost( ̄工 ̄lll) 这时候我们可以打开这个文档, 把他内容粘贴到编辑器里, 全局替换这个域名, 再导入到 Postman 里, 选择导入文件即可.

调用

还有一点牛逼的是, 他可以设置环境~ 也就是说, 设置一个环境变量, 再每条调用之下就能直接使用. 这个就比直接在网页上使用 Swagger 强好多了. 而且!

1
2
你试试直接选中一条点击`Send`, 可以看到参数的地方默认有一个`{{这里是 name}}` 的调用,
`{{}}`这个是里面引用变量的格式,

所以说, 里面已经有了默认的引用, 我们只需要给环境添加这个变量就可以了! 比如说 token, 我们添加一个和调用一样名字的环境变量, 那么调接口的时候就能正确拿到这个变量~ 好省事的说~

又 get 到节约生命的一招~