00:00
这节课学习一下啊,顶口一篇。看一下文档的地址。好,把右边的关掉。这是啊,叮嘱API的一个文档,首先我们要使用这个包呢,要先安装这个包。先简单介绍一下顶果API是做什么的啊,它就是。会帮我们把我们的这个API的这个呃,项目啊,不管是处理请求也好,或者处理响应也好啊,都提供了一个很好的一个支持。当然我们使用原生的LA也是可以去,嗯,完成这个。API的一个响应,但是没有啊,这种专业的这种。包它提供的功能丰富啊,所以我们在写这种纯API的项目的时候使用啊,专门用来写API的这种工具。啊是比较好的,包括他的这个对于响应的一些支持都是不错的,当然要使用这个包呢,我们首先安装这个包。啊,直接。
01:00
执行这个命令就进行安装就可以啊。在哪里去执行这个命令呢?在我们的虚拟机里面啊,我们home也就是。虚拟机里面。所以。啊,要去打开一个CMD终端,用管理员的身份打开。之后啊,CD进入到我们home state的这个目录。找到你的加目录里面的homestead。进去啊,复制一下这个地址,你的用户的加目录下面的这个红色的。好之后使用SSH连上这个虚拟机。在连上虚拟之后进入到啊我们的项目目录。进入了我们的这个项目的目录。去执行这个命令。CD的。扣的啊。因为现在是在加目录嘛,对吧,加目录,所以我们要CD到这个code里面,哎,我们的项目是在虚拟机里面的code里面CD到我们的这个小API,好在这个项目里面去。
02:13
复制一下这个命令啊。安装就是说执行这个命令去安装。定位片。在安装完成之后呢。嗯,还需要啊进行一些配置。就是把它的这个发布文件从window目录给发布到我们的卡目录啊,因为我们安装完成之后,它会在这个window window目录下,我们的window目录是不被这个啊get给托管的,一般我们在去部署项目的时候,也是不会去包含这个目录的啊,所以啊,我们把它的这个配置文件去给他发布到con菲里面。
03:00
首先看一下啊,这里已经安装完成了,快。正在去。写入文件。啊。啊,这里提示了我们。内存不足啊,当我们去装一些组件提示内存不足的时候。可以怎么办呢?可以临时去。呃,提升这个就是说临时去取消composer这个内存限制去安装啊。Com。Me?More。等于负一。然后去复制上。啊,我们的这个安装的这个命令。就可以了啊。回撤。
04:00
这时候他就不会去报这个内存不足的一个错误。啊,使用这个命令啊,临时去把这个composer这个内存的一个设置给取消掉啊,就不限制,暂时不限制它的内存,这么去安装,在装其他的啊com组件的时候,如果提示你这个内存不足啊,内存不足的话,都可以使用这种方式。去安装。啊,已经正在安装了,我们先去复制一下这个命令,等它安装完成之后,我们执行这个命令把。啊。订购API的这个配置,从目录去发布到。我们的康菲格目录。好,这里已经安装完成,安装完成之后。把这个命令右键粘贴过来。没有复制上啊,复制一下。右键粘贴过来。好,这样就发布成功了,你注意我们的所有的命令执行都是在虚拟机里面进行的,而且是在我们的项目所在的这个目录啊,项目的这个目录。
05:05
接下来发布完成之后,这里就多了一个啊api.pp的一个配置文件,这个就是我们订购API所有的一个配置。啊,接下来。你去看一看。它所有相关的一些配置啊。配置信息。在这一章介绍了我们所有可用的啊一个配置,首先第一个配置就是标准数。啊,标准数呢啊,就是说我们的这个API的所使用的一个标准,一般的话。我们不清楚使用什么的时候,X就可以啊,使用X就可以,我们可以在EV里面去啊配置这个你看我们的。api.pp是吧,它所有的配置都是从E里面这里面去取,对吧,并且给到这个默认值,但我们去看EV的话,发现没有这些配置,是不是,这时候你只要在下面自己去加上啊这个配置就可以了,你这里。啊,那我们这里使用X吧,这个标准数。
06:02
啊,接着看一个子类型,子类型通常是我们项目的一个短名称。也可以在ena里面去配这个啊,当然所有的配置其实都是在app.pp里面的,你往下看就是一个子类型对不对,并且这个没有给默认值,但是我们可以在E里面去给它写上,嗯,写上我们的shop吧。接着就是前缀和紫月。就是前缀的话,就是我们在请求这个API地址的时候要加上的这个前缀。哎,我们使用这个就可以啊,也是可以啊,其实所有的配置都是在这里面去配置的嘛,包括它的这个版本号啊,啊前缀啊啊这个我们就啊,等会儿再过来看一下啊。先把那个前缀给他加上,还使用API就可以了。啊,接下来是啊,这个版本号对吧,版本号我们使用V1,当然你不配的话,不配这个里面也也可以,它这个它会给去默认使用这个默认的一个值啊,不过最好我们还是把相关的常用的一些配置放到,因为里面这样方便我们去啊做一些更改。
07:03
啊,尽可能的啊,不要直接去改这个啊,卡里面的配置啊,以免对,就是说以免你的本地的一些配置和生产环境的配置不一样啊,结果导致你的代码部署到生产环境,造成一些。啊,不好的一些影响。尽可能的我们在因为里面去设置我们的配置。啊,接着往下看,还有就是名称,名称呢,就是我们的这个啊。这个项目的一个啊名称,它会在我们去生成这个文档的时候啊会用到。这里呢也直接啊去改啊,注意一下这个拉的这个点,因为是不支持,就是说空格的话可能会出问题,所以一般你有空格的话,加上这个双引号啊。好,但这里的话,我们还是写成效果就可以了。接着看还有什么配置条件请求啊,条件请求啊,默认它是开启了,这里我们把它关闭啊,条件请求一旦开启了,就是说客户端它会启动啊一些。
08:02
缓存机制去缓存我们的一些请求,我们在开发测试阶段就把这个给关闭就可以了。好,接下来看看还有什么配置啊,这些配置项其实在这个里面都是都是可以找到的啊,我们先看手册去写一下。严格模式啊,如果是启用了严格模式,就是我们在请求API的时候,客户端必须得发送这个头,不然的话就会抛出一个异常。对不对,所以我们啊,做这个测试阶段,开发测试阶段就把这个取消掉,当然一般其实生产环境也很少去开这个啊头。啊。一般我们就说。对自己的API做好一些啊,认证做好一些限制,就可以起到一个保护的作用,当然如果你的API非常的重要啊,比较追求安全,也是可以加强这个。啊,他就是说你必须就当我开启严格模式,你必须在发送的请求里面的头信息里面写入这个头信息,并且指定上你要请求这个版本号,如果啊,这个你。
09:06
不给这个头信息就会报错啊,这里我把它关掉就可以了啊。在这个讲到请求一篇的时候,我们会说一下啊,如何使用这个accept去请求指定版本的API。好。接下来是呃,认证服务,认证服务啊,是在这个是找这个also啊,它这里面没写。这里啊,认证服务。认证服务呢,呃,一般你什么都不会的话,它默认使用的是这个这个。默认的这个配置对吧,当然我们不会去使用这个配置,因为我们是做一个纯API的项目,有的像,嗯,比如说像手机端去使用的话,因为手机端有的是不可能去写入这个,传入这个cookie,这样的话就没办法我们使用session,所以我们一般不去使用这个。啊,默认的这个认证机制会使用一个。啊,无状态的基于talking的一个认证。
10:01
方式这个我们到后面,诶,就是说认证这里会说啊。还有就是访问节流啊,访问节流呢。嗯。它的配置项是在这个是具体怎么配置啊,你看这里也说了,我们在后面使用这个认证的这个服务的时候,去可以去使用这个GWC的一个认证服务啊好。接下来看一下这个访问截流,访问节流,其实就是说啊,去设置了我们的这个API的一个啊频率,请求频率,比如我们限定每分钟可请求多少次,这个配置是在哪呢。是在。看看在哪儿有一个。啊,这个啊,它啊,当然现在是没有配置,我们后面可能用的时候也不去进行配置,而是在。啊,就是中间键里面路由中间里面直接去写啊,还有一个就是响应的一个转换啊,响应的转换呢,默认的啊使用的是这个转换规则,但我们一般会配合什么使用呢?配合这个transform啊,进行一些我们自定义的一些响应。
11:07
包括这个响应的格式啊,默认的响应格式是杰森,然后杰森这个数据类型大概是我们这个很多系统去交互用的比较多的一个啊一个方式,所以我们这使用杰森可以了。好。还有就是啊,错误的一些格式,就是当我们出现错误的时候,就是生成那个错误信息的时候,错误信息的一个模板也是要返回哪些错误信息啊,这个在配置文件里面也都是可以去配置的,在下面一点。在。这里这一点啊,这个错误的这个啊,一个模板就是都返回什么错误信息啊,然后关于响应的一些阶层类型在这里面。也是可以配置的啊。就是格式化响应的一个类型。好调试模式。当我们打开调试模式的时候,当我们报错的时候,他就会啊帮我们把这个啊堆栈的一个追踪给填充上。
12:04
否则的话,就只有错误的一个提示。这个我们要加上,方便我们去开发测试,当然如果是线上的这个版本,你可以把它给关掉。关于配置就说到这里。
我来说两句