如何获取接口文档里的数据以及如何看懂接口文档

实习生一个,没有项目经验,刚来公司一周,给我一个需求,让我把两个系统打通。即把B系统(人员管理系统)的人员导入到A系统(我们部门的项目管理系统)。然后给了我一个B系统的开发文档,拿到手我都懵了,不知如何下手呀。以我的固定思维,我以为会把A系统的代码导入到Idea,在它的源代码写一个类,去get到B系统的数据。结果我理解错了,是让我写一个中间件,从B的接口文档拉数据,然后再推到A,当然A也有接口文档。

现在第一步是如何看懂这个文档。首要问题是,接口文档中的请求地址:http:/(如下图) ,它是一个页面呢,还是对方已经把数据给我封装在这个url里,手动打不开,需要编写代码才能get到这里面的数据。如果是这样的话,那写文档的人是如何做到的呢,感觉好新鲜。
比如:

img

很明显这是后端接口呀,你们的项目应该是前后端分离项目,通过传参返回json数据,写文档的人要么就是测试接口后将相关信息写在文档里面,要么就是通过程序生成的文档,至于写文档的人员是如何知道后端接口的以及用什么参数,其实很简单,在开发环境中后端会使用一个叫swagger的工具,其实就是在pom.xml里面引入依赖,然后通过注解的方式注明,哪个是实体类,哪个是controller点进入可以看到每一个controller接口以及参数的详细说明,测试人员或者前端人员通过后端提供的接口说明可以更好的编写页面交互功能

根据提供的接口文档去写接口,以及封装好对应的参数。
提供接口给另一个系统调用和页面调用一样的。清楚流程就很清楚怎么做了
两个系统里面也都有接口,可以参考。

都实习了 可定写过 Controller、service 这些吧。你把B的这个接口文档的一个接口当成一个service的方法,参数就是参数说明里的,返回值就是它的返回结果,这样就get到B的数据了;
A的接口文档就相当于另一个service的方法,一样的操作,只是把方法调用换成 http请求

后端人员会使用swagger,正如楼上那位专家所说将编写的接口,以及参数,实体类以及属性说明告知其他人,省的后端人员一一给其他人介绍自己写的功能都是干什么有什么作用,编写文档的人员访问指定地址看到后自然知道该怎么用

这就是java前后端通过http连接啊,去了解http通信吧。

  1. 先看token的接口,获取token要参数的,通常是appkey和appsecret,参数如果没有就要,先请求这个拿到token,并把token放在缓存,小心CRLF攻击
  2. 其他接口,目前看是要带token的,就通过签名那个token+相应的参数获取(有的走Oauth 2.0,就要把token放到头部的authorization参数里面)
  3. 注意有些token是有时效性的,过了时间要重新获取