温馨提示:文本由机器自动转译,部分词句存在误差,以视频为准
00:00
大家好,这节课给大家介绍一下API文档的一个使用,那这个是API文档的一个地址。先看一下这个说明文档啊,因为我们的这个API会有很多人在使用,所以会对数据进行不定期的一个回档啊,如果呃,你写的这个项目,比如数据哎,突然没了或者怎么回事,那可能就是这个数据进行回档了,你需要再重新去添加数据等等啊,这个要注意,然后API的请求域名啊,是这个域名。注意要用这个HTPS啊,因为我们这边域名的话,就是说这个API开启了强制如果不使用APS,会导致部分的这个请求行为,比如说post put等请求失败。再然后,呃,我们的用户认证使用的是呃GW认证,所以在一些需要认证的API,我们要添加这个请求头,那这个。呃,在我们写这个登录注册的时候,会再详细去说这一块啊。
01:01
然后还提供了两个默认用户,一个是普通用户,一个是超级管理员,我们写后台的这个项目的话,就会用到啊,超级管理员这个用户啊。再有就是全局的一个状态码。大家在请求这个API的时候啊,可以根据响应的一个状态码去看一看啊,具体的一个情况。然后是数据字典,数据字典呢,就是我们整个项目是呃,数据表的一个设计,哎,比如说有些字段你不太清楚是做什么的,可以去看数据字典每个字段的一个,呃,详细的一个介绍啊。然后认证相关的,比如说登录啊,相关的我们就去这个认证API里面去,诶找这个相应的一个接口,当然我们写后台的话,可能只会用到这个登录啊,因为后台我们不涉及注册等等。啊,当然也会用到这个退出啥的。啊,那前台的这个API呢,是我们之前的一个view的项目,写的是一个前台的一个商城,然后使用的是前台的,那我们这个是后台管理的一个项目的话,使用的是后台相关的一些API啊。
02:12
大家可以看到啊,所有的API已经,呃,按照这个组进行了一个。整理我们写到哪一个模块的时候,去对应的这个组里面去找对应的这个API就可以了啊,那文档呢,大概分这么几个部分,一个是接口的一个描述啊,你请求的一个一个地址啊,注意这是U,你要连上前面我们说明文档里面的域名就可以了。然后是请求的一个方式,以及呃,需要认证的接口的话,你要带上这个请求头。呃,接下来是请求的一些参数,如果是,呃。啊,这种get请求方式进行一些数据查询的操作的话,会提供一些啊query的请求参数,一般用作这个搜索等等等等啊,当然如果是一些表单的提交,哎,可能会有这个包的一个参数啊。接下来看一看这个返回的一个参数啊,返回的参数呢,如果是多个字段,会把每一个字段里面可能包含的这个数据给大家一一的给列出来,呃,后面还有一个简短的一个说明。
03:10
有时候这个说明比较简单的话,就是不是特别清晰的话,你可以去数据字典里面去找到对应的表,去看详细的一个,呃,这个字段的一个介绍。关于文档的啊,地址就是这个地址啊,当然也给大家放到了这个笔记里面,在这里面啊,大家点击就可以去。拿到这个地址。啊,这小节先到这里。
我来说两句